PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
These properties can be used on the HFSQL objects described in the data model editor, in the query editor or through programming.
AbbreviationThe Abbreviation property is used to get the abbreviation of the data file. This abbreviation was defined in the data model editor when describing the data file. This property is read-only.
AccessThe Access property is used to manage the type of access of a connection (HFSQL Client/Server, OLE DB, etc.).
ActiveDirectoryThe ActiveDirectory property allows you to connect to an HFSQL server with authentication through Active Directory.
CharsetThe Charset property is used to:
  • Find out the character set used by a Font variable.
  • Modify the character set used by a Font variable.
  • Find out the character set used by an HFSQL data file.
YearThe Year property is used to:
DatabaseThe Database property is used to manage databases associated with a connection (HFSQL Client/Server, OLE DB, etc.).
BinaryThe Binary property is used to determine if an item is binary.
MaxValueThe MaxValue property is used to:
  • find out and modify the upper bound of a report based on a data file.
  • find out the upper bound defined for the current filter.
  • find out the maximum value of a chart series.
  • find out and modify the maximum value for some types of controls.
MinValueThe MinValue property is used to:
  • find out and modify the lower bound of a report based on a data file.
  • find out the lower bound defined for the current filter.
  • find out the minimum value of a chart series.
  • find out and modify the minimum value for some types of controls.
MaxLinkedCardinalityThe MaxLinkedCardinality property is used to get and modify the maximum cardinality of the related item in the link.
MinLinkedCardinalityThe MinLinkedCardinality property is used to get and modify the minimum cardinality of the related item in the link.
MaxSourceCardinalityThe MaxSourceCardinality property is used to get and modify the maximum cardinality of the source item in the link.
MinSourceCardinalityThe MinSourceCardinality property is used to get and modify the minimum cardinality of the source item in the link.
CompositeKeyThe CompositeKey property is used to determine if an item is a composite key.
LinkedKeyThe LinkedKey property is used to set the characteristics of a link
SourceKeyThe SourceKey property is used to set the characteristics of a link.
SQLCodeThe SQLCode code property is used to get the SQL code of a query created with the query editor (".WDR" file).
ComponentThe Component property configures the different components of a composite key.
CompressionThe Compression property is used to manage data compression during a connection (HFSQL Client/Server, etc.)
MmoPackMethodThe MmoPackMethod property is used to set the compression mode of the MMO file (containing text and binary memos) associated with the data file.
FilterConditionThe FilterCondition property allows you to know the selection condition set by HFilter on a data file, HFSQL view or query.
ConnectionThe Connection property is used to find out and modify the connection currently associated with a data file.
CryptMethodThe CryptMethod property allows you to manage the type of encryption used between Client computers and an HFSQL server.
FicCryptMethodThe FicCryptMethod property is used to set the encryption method of a data file.
MmoCryptMethodThe MmoCryptMethod property is used to set the encryption method of the memo file (.MMO) associated with the data file.
NdxCryptMethodThe NdxCryptMethod property is used to configure the encryption method for the index (.NDX) file associated with the data file.
CtAccessThe CtAccess property is used to set the type of access to the data file when connecting to a specific table via OLE DB.
CtDescribedAccessThe CtDescribedAccess property is used to set the type of access to the data file when connecting to a specific table via OLE DB.
CtDatabaseThe CtDatabase property is used to set the OLE DB data source when connecting to a specific table via OLE DB.
CtDescribedDatabaseThe CtDescribedDatabase property is used to set the OLE DB data source when connecting to a specific table via OLE DB.
CtExtendedInfoThe CtExtendedInfo property is used to get the additional information inserted into database connection string.
CtInitialCatalogThe CtInitialCatalog property is used to get the default database defined for the access.
CtDescribedCaptionThe CtDescribedCaption property is used to get and set the caption of the connection to the OLE DB data source.
CtDescribedPasswordThe CtDescribedPassword property allows you to set the password used to open the data file in an OLE DB connection (file defined in the code only).
CtCursorOptionsThe CtCursorOptions property is used to get the type of cursor used when connecting to an external database.
CtOLEDBProviderThe CtOLEDBProvider property is used to get and set the name of the OLE DB provider (also called OLE DB server).
CtDescribedOLEDBProviderThe CtDescribedOLEDBProvider property is used to get and set the name of the OLE DB provider (also called OLE DB server).
CtCacheSizeThe CtCacheSize property is used to determine and change the maximum number of records that can be stored in the cache of the Native MySQL Connector.
CtUserNameThe CtUserName property is used to set the username that will be used when connecting to a specific table via OLE DB.
CtDescribedUserNameThe CtDescribedUserName property is used to set the username that will be used when connecting to a specific table via OLE DB.
TypeDescriptionThe TypeDescription property is used to:
  • Find out the type used by an Enumeration or Combination item. This item was defined in the data model editor or through programming.
  • Define the type used by an Enumeration or Combination item (when describing the item through programming).
ExecutionCompletedThe ExecutionCompleted property is used to determine whether the execution of a query or view (HFSQL Classic or Client/Server) is completed.
ExtensionThe Extension property is used to:
  • get the extension of a file defined in the data model editor or through programming.
  • define the extension of a file (when the file is described through programming only).
LogFileThe LogFile property is used to determine if a data file is a log file.
InitialFileThe InitialFile property is used to get the original name of the data file associated to an item in a query.
BrowsedFileThe BrowsedFile property is used to get and change the data source used to display records in controls based on a data file.
LinkedFileThe LinkedFile property is used to set the characteristics of a link.
SourceFileThe SourceFile property is used to set the characteristics of a link.
TransactionFileThe TransactionFile property is used to determine if a data file is a transaction file.
FilterWithBoundsThe FilterWithBounds property is used to determine if bounds have been specified for the filter implemented by HFilter on an HFSQL data file, view or query.
FilterThe Filter property is used to identify and change the filter applied to records in:
  • Table controls based on a data file,
  • browsing TreeView Table controls,
  • browsing List Box controls,
  • browsing Combo Box controls,
  • browsing Looper controls.
FormatThe Format property is used to define the data format of a data file.
KeyExpressionThe KeyExpression property is used to set the different components of a composite key.
CalculatedItemExpressionThe CalculatedItemExpression property is used to:
  • Find out the SQL expression that defines the value of a calculated item. This item was defined in the data model editor or through programming.
  • Define the SQL expression returning the value of a calculated item (when describing the item through programming).
ManageHTMLManageHTML is used to configure the management mode of the HTML format in a full-text index.
ManageRTFManageRTF is used to configure the management mode of the RTF format in a full-text index.
HugeFileThe HugeFile property is used to configure the maximum size of a data file.
GUIDAnalysisThe GUIDAnalysis property returns the GUID of the analysis that was used to create the data file.
GUIDFileThe GUIDFile property returns the GUID of the file defined in the analysis that was used to create the data file.
MaxThumbnailHeightThe MaxThumbnailHeight property is used to get and change the maximum height of a thumbnail of an Image item (binary memo).
HourThe Hour property is used to:
  • Get the time from a variable of type Time or DateTime, or the number of hours from a variable of type Duration.
  • Change the time in a variable of type Time or DateTime, or the number of hours in a variable of type Duration.
  • Retrieve the time or the number of hours from a Date item (in "Date and time" or "Duration" format) or from a Time item.
  • Modify the time or the number of hours in a Date item (in "Date and time" or "Duration" format) or in a Time item.
MaxAutoIDThe MaxAutoID property is used to get the maximum automatic identifier of a replicated data file.
MinAutoIDThe MinAutoID property is used to get the minimum automatic identifier of a replicated data file.
UnalterableThe Unalterable property is used to configure the unalterability of a data file: the data file cannot be modified; only additions can be made.
IndexThe Index property indicates the physical index (physical order) of an item in a record.
InfoThumbnailGenerationThe InfoThumbnailGeneration property is used to determine if the thumbnails of an item have been generated successfully.
ExtendedInfoThe ExtendedInfo property is used to get additional information:
  • about a data file accessed by a Native Connector or HFSQL Client/Server.
  • about an item accessed by a Native Connector or HFSQL Client/Server.
  • about a connection. In this case, this property is equivalent to CtExtendedInfo.
DayThe Day property is used to:
  • Get the day from a Date or DateTime variable, or get the number of days from a Duration variable.
  • Change the day of a Date or DateTime variable, or change the number of days of a Duration variable.
  • Get the day or the number of days from a Date item (in "Date", "Date and Time" or "Duration" format)
  • Modify the day or the number of days in a Date item (in "Date", "Date and Time" or "Duration" format)
LogMethodThe LogMethod property is used to:
  • find out the log mode used for a data file (file defined in the data model editor or through programming).
  • define the log mode used for a data file (when the file is described through programming).
LanguageThe Language property is used to set the language used to compare and sort Unicode items (Unicode Text item or Unicode Text Memo item).
LanguageDescribedThe LanguageDescribed property is used to set the language used to compare and sort Unicode items (Unicode Text item or Unicode Text Memo item).
MaxThumbnailWidthThe MaxThumbnailWidth property is used to get or change the maximum width of a thumbnail of an Image item (binary memo).
CaptionIn a database, the Caption property is used to:
  • Find out the caption associated with a file item.
  • Find out the caption associated with a data file.
  • Find out and modify the connection caption.
In a report, the Caption property is used to:
  • Find out the text displayed in a Static or Link control.
  • Modify the text displayed in a Static or Link control.
In a window or page, the Caption property is also used to:
  • Find out and modify the caption of a control in a window or in a page.
  • Find out and modify the caption of a menu option.
  • Find out and modify the title of a window or page.
  • Find out the content of a Breadcrumb control.
MinimumLengthThe MinimumLength property is used to configure the minimum length of the words to be indexed.
New in version 27
spAge
The spAge property gets the time elapsed since the password was last changed.
New in version 27
spMatchesDescription
The spMatchesDescription property determines if the parameters (key derivation function, hash algorithm, iteration count and output length) of the item of type "Password" in the data file match the parameters described programmatically or in the analysis.
New in version 27
spDerivation
The spDerivation property is used to:
  • Get the key derivation function used to hash an item of type "Password". This property can be used for items of type "Password" defined in the data model editor or programmatically.
  • Set the key derivation function used for hashing (only for "Password" items defined programmatically).
New in version 27
spHash
The spHash property is used to:
  • Get the algorithm used for salting an item of type "Password". This property can be used for items of type "Password" defined in the data model editor or programmatically.
  • Set the algorithm used for salting (only for "Password" items described programmatically).
New in version 27
spIterationCount
The spIterationCount property is used to:
  • Get the iteration count of the hash algorithm used for an item of type "Password". This property can be used for items of type "Password" defined in the data model editor or programmatically.
  • Sets the iteration count of the hash algorithm used for an item of type "Password" (only for "Password" items described programmatically).
New in version 27
spLength
The spLength property is used to:
  • Get the hash output length. This property can be used for items of type "Password" defined in the data model editor or programmatically.
  • Set the hash output length (only for "Password" items defined programmatically).
MemoThe Memo property is used to determine if an item is of type memo.
MillisecondThe Millisecond property is used to:
  • Retrieve the number of milliseconds from a Time, DateTime or Duration variable.
  • Modify the number of milliseconds in a Time, DateTime or Duration variable.
  • Retrieve the milliseconds or the number of milliseconds from a Date item (in "Date and Time" or "Duration" format)
  • Modify the milliseconds or number of milliseconds in a Date item ("Date and Time" or "Duration" format)
MinuteThe Minute property is used to:
  • Retrieve the minutes from a Time or DateTime variable, or the number of minutes from a Duration.
  • Change the minutes in a Time or DateTime variable, or the number of minutes in a Duration.
  • Retrieve the minutes or the number of minutes from a Date item (in "Date and Time" or "Duration" format) or from a Time item.
  • Modify the minutes or the number of minutes in a Date item (in "Date and Time" or "Duration" format) or in a Time item.
MonthThe Month property is used to:
  • Retrieve the month from a Date or DateTime variable.
  • Modify the month in a Date or DateTime variable.
  • Retrieve the month from a Date item (in "Simple date" or "Date and Time" format)
  • Modify the month in a Date item (in "Simple Date" or "Date and Time" format)
PasswordThe Password property can be used:
  • on the edit controls (or on the text table columns) to find out whether the control is a "Password" control or to modify the "Password" type of the control.
  • on the connections (HFSQL Client/Server, OLE DB, etc.) to define the password of the user who is using the connection.
WDD55PasswordThe WDD55Password property is used to specify the password of the 5.5 analysis that contains a Hyper File 5.5 data file used in an HFSQL Classic analysis.
StopWordThe StopWord property is used to define stopwords in a full-text index defined through programming.
NbComponentThe NbComponent property is used to get the number of elements in a composite key.
NbArrayElementNbArrayElement is used to configure the number of elements in an array item.
NbItemThe NbItem property is used to get the total number of items (including composite keys) in a record of:
  • a file described in the data model editor,
  • a file described through programming,
  • an HFSQL view,
  • a query.
NbKeyItemThe NbKeyItem property is used to get the total number of key items (including composite keys) in a record of:
  • a file described in the data model editor,
  • a file described through programming,
  • an HFSQL view,
  • a query.
NbMemoItemThe NbMemoItem property is used to get the total number of memo items in a record of:
  • a file described in the data model editor,
  • a file described through programming,
  • an HFSQL view,
  • a query.
NbThumbnailThe NbThumbnail property is used to get the number of thumbnails generated for an item.
NbDescribedThumbnailThe NbDescribedThumbnail property is used to get the number of thumbnails expected for an item.
NameThe Name property is used to get:
  • the name of the font associated with a Font variable.
  • the name of a control, report or report block.
  • the name of a control, group of controls or window.
  • the name of a control, group of controls or page.
Name55The Name55 property is used to manipulate the logical name of a Hyper File 5.5 data file that has not been migrated and is located in a WINDEV 19 analysis.
DescribedNameThe DescribedName property is used to handle the logical name of HFSQL data files (ignoring possible changes made by HAlias).
PhysicalNameThe PhysicalName property is used to manage the physical name of HFSQL data files.
DescribedPhysicalNameThe DescribedPhysicalName property is used to manage the physical name of HFSQL data files.
NewRecordThe NewRecord property is used to determine if the record is a new record or if it comes from the data file.
NullThe Null property is used to:
  • Assign NULL to the item for the current record.
  • Find out whether the item is associated with the NULL value for the current record.
  • Define the default value of an item when the item is described through programming.
NullSupportedThe NullSupported property is used to manage the NULL value in HFSQL data files.
NumericalNumerical is used to find out whether an item is a numeric item.
GenerationNumberThe GenerationNumber property is used to get the generation number of the physical data file associated with the logical data file.
CursorOptionsThe CursorOptions property is used to manage the type of cursor used for a connection (Native Connectors, OLE DB, etc.).
DateThe Date property is used to:
  • Retrieve the date from a DateTime variable.
  • Modify the date in a DateTime variable.
  • Retrieve the date from a Date item (in "Date and Time" format) .
  • Modify the date in a Date item (in "Date and Time" format)
DecimalPartThe DecimalPart property is used to configure Numeric items.
IntegerPartThe IntegerPart property is used to configure Numeric items.
TimeThe Time property enables you to:
  • Retrieve the time from a DateTime variable.
  • Modify the time in a DateTime variable.
  • Retrieve the time from in a Date item (in "Date and Time" format)
  • Modify the time in a Date item ("Date and Time" format).
PersistedCalculatedItemThe PersistedCalculatedItem property is used to:
  • Find out whether the value of a calculated item is stored in the data file. This item was defined in the data model editor or through programming.
  • Define whether the value of a calculated item is stored in the data file (when describing the item through programming).
PasswordProtectedThe PasswordProtected property is used to determine if a datafile is password-protected.
ProviderThe Provider property is used to manage the type of a connection (HFSQL Client/Server, OLE DB, etc.).
StemmingThe Stemming property is used to enable stemming and to define the language used for stemming in a full-text index defined through programming.
ModificationRuleThe ModificationRule property is used to configure the modification rule (integrity management) to be applied to the data file described in the code.
DeletionRuleThe DeletionRule property is used to configure the deletion rule (integrity management) to be applied to the data file described through programming.
RepeatableReadSupportedThe RepeatableReadSupported property is used to:
  • Find out whether the data file (file defined in the data model editor or through programming) can be used in HFSQL Client/Server in a transaction that includes a "Repeatable Read" isolation mode.
  • Allow the use of a transaction that includes a "Repeatable Read" isolation mode for a data file (when the file is described through programming only).
DirectoryThe Directory property is used to manage the physical directory of HFSQL files.
DescribedDirectoryThe DescribedDirectory property is used to manage the physical directory of HFSQL files.
LogDirectoryThe LogDirectory property is used to manage the directory of the log file described in the analysis.
OperationLogDirectoryThe OperationLogDirectory property is used to manage the directory of the operation log file associated with a data file.
ReplicationDirectoryThe ReplicationDirectory property is used to manage the directory of replication files (".RPL" or ".RPM").
LogBackupDirectoryThe LogBackupDirectory property is used to manage the backup directory of log files.
ReplicationThe Replication property is used to:
  • find out the replication mode used for a data file (file defined in the data model editor or through programming).
  • specify the replication mode used for a data file (when the file is described through programming).
GDPRThe GDPR property is used to:
  • find out if the GDPR applies to an item from a data file.
  • define whether the GDPR should apply to an item (in the item description in the code only).
FilteredItemThe FilteredItem property is used to identify the item that has a filter implemented by HFilter.
InitialItemInitialItem is used to find out the initial name of an item found in a query. This name is known from the alias of this item.
ItemsThe Items property is used to configure the different items of a full-text index.
TextItemCompletedThe TextItemCompleted property is used to manage text items in an HFSQL data file.
SecondThe Second property is used to:
  • Retrieve the number of seconds from a Time, DateTime or Duration variable.
  • Modify the number of seconds in a Time, DateTime or Duration variable.
  • Retrieve the seconds or the number of seconds from a Date item (in "Date and Time" or "Duration" format)
  • Modify the seconds or the number of seconds in a Date item (in "Date and Time" or "Duration" format)
SecureThe Secure property is used to configure the security level of data file encryption.
AccentSensitiveThe AccentSensitive property is used to determine if accented characters are taken into account in the different searches performed on the item (with HReadSeek, HReadSeekFirst and HReadSeekLast, for example).
CaseSensitiveThe CaseSensitive property is used to determine if the different searches performed on the item distinguish between uppercase and lowercase characters (with HReadSeek, HReadSeekFirst and HReadSeekLast, for example).
PunctuationSensitiveThe PunctuationSensitive property is used to determine if punctuation characters (comma, period, etc.) are taken into account in the different searches performed on the item (with HReadSeek, HReadSeekFirst and HReadSeekLast, for example).
ServerThe Server property is used to manage the data source of a connection (HFSQL Client/Server, OLE DB, etc.).
SourceThe Source property can be used on:
  • a Chart control: in this case, the Source property is used to get the source of the series: Table column, list of values, ...
  • a connection: in this case, the Source property is used to get or set the source of a connection (HFSQL Client/Server, OLE DB, etc.).
SynonymThe Synonym property is used to define synonyms in a programmatically defined full-text index.
CacheSizeThe CacheSize property is used to:
  • Get the maximum number of records that can be stored in the cache of the Native MySQL Connector.
  • Change the maximum number of records that can be stored in the cache of the Native MySQL Connector.
KeySizeThe KeySize property is used to set the characteristics of a text memo key item.
RecordSizeThe RecordSize property is used to get the size (in bytes) of a record in:
  • a file described in the data model editor,
  • a file described through programming,
  • an HFSQL view,
  • a query.
SizeThe Size property is used to determine and change the size of an element.
TextText is used to find out whether an item is a text item.
TimestampTypeThe TimestampType property is used to:
  • Find out the type of timestamp for an item. This item was defined in the data model editor or through programming.
  • Define the type of timestamp for a Date, Time or DateTime item (when describing the item through programming).
TimestampUTCThe TimestampUTC property is used to:
  • Find out whether a timestamp item will use UTC time or local time. This item was defined in the data model editor or through programming.
  • Define whether a timestamp item will use UTC time or local time (when describing the item through programming).
TypeThe Type property is used to get:
  • the type of element described through programming (file or item description) or not (file or item defined in the data model editor, view or query).
  • the type of object.
  • the type of value stored in a variant.
KeyTypeThe KeyType property is used to set the characteristics of a key item.
SortTypeThe SortType property is used to:
  • Find out the sort direction defined for an item or for a component of a composite key. This item was defined in the data model editor or through programming.
  • Define the sort direction for an item or for a component of a composite key (when describing the item through programming).
UserThe User property is used to manage the user of a connection (HFSQL Client/Server, OLE DB, etc.).
DefaultValueThe DefaultValue property is used to:
  • Find out the default value of an item. This item was defined in the data model editor or through programming.
  • Define the default value of an item (when describing the item through programming).
CalculatedDefaultValueThe CalculatedDefaultValue property is used to:
  • Find out the SQL expression that defines the default value of an item. This item was defined in the data model editor or through programming.
  • Define the SQL expression that returns the default value of an item (item described through programming only).
ThumbnailThe Thumbnail property is used to:
  • get the value of an item thumbnail. This item was defined in the data model editor or through programming.
  • get and change the image associated with a Thumbnail control.
VisibleEndUserThe VisibleEndUser property is used to:
  • Find out whether an item is visible or not to the end users. This item was defined in the data model editor or through programming.
  • Define whether an item must be visible or not to the end users (when describing the item through programming).
WDD55WDD55 is used to:
  • Find out the name and full path of the WDD file in Hyper File 5.5 format.
  • Define the name and full path of the WDD file in Hyper File 5.5 format.
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment