PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Version: 27

Home | Sign in | English EN
Category: HFSQL properties
The 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.
The 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).
The Access property is used to manage the type of access of a connection (HFSQL Client/Server, OLE DB, etc.).
The ActiveDirectory property allows you to connect to an HFSQL server with authentication through Active Directory.
The Binary property is used to determine if an item is binary.
The BrowsedFile property is used to get and change the data source used to display records in controls based on a data file.
The 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.
The 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).
The 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).
The 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).
The 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.
The Component property configures the different components of a composite key.
The CompositeKey property is used to determine if an item is a composite key.
The Compression property is used to manage data compression during a connection (HFSQL Client/Server, etc.)
The Connection property is used to find out and modify the connection currently associated with a data file.
The CryptMethod property allows you to manage the type of encryption used between Client computers and an HFSQL server.
The CtAccess property is used to set the type of access to the data file when connecting to a specific table via OLE DB.
The 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.
The CtCursorOptions property is used to get the type of cursor used when connecting to an external database.
The CtDatabase property is used to set the OLE DB data source when connecting to a specific table via OLE DB.
The CtDescribedAccess property is used to set the type of access to the data file when connecting to a specific table via OLE DB.
The CtDescribedCaption property is used to get and set the caption of the connection to the OLE DB data source.
The CtDescribedDatabase property is used to set the OLE DB data source when connecting to a specific table via OLE DB.
The CtDescribedOLEDBProvider property is used to get and set the name of the OLE DB provider (also called OLE DB server).
The 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).
The CtDescribedUserName property is used to set the username that will be used when connecting to a specific table via OLE DB.
The CtExtendedInfo property is used to get the additional information inserted into database connection string.
The CtInitialCatalog property is used to get the default database defined for the access.
The CtOLEDBProvider property is used to get and set the name of the OLE DB provider (also called OLE DB server).
The CtUserName property is used to set the username that will be used when connecting to a specific table via OLE DB.
The CursorOptions property is used to manage the type of cursor used for a connection (Native Connectors, OLE DB, etc.).
The Database property is used to manage databases associated with a connection (HFSQL Client/Server, OLE DB, etc.).
The DecimalPart property is used to configure Numeric items.
The 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).
The DeletionRule property is used to configure the deletion rule (integrity management) to be applied to the data file described through programming.
The DescribedDirectory property is used to manage the physical directory of HFSQL files.
The DescribedName property is used to handle the logical name of HFSQL data files (ignoring possible changes made by HAlias).
The DescribedPhysicalName property is used to manage the physical name of HFSQL data files.
The Directory property is used to manage the physical directory of HFSQL files.
The ExecutionCompleted property is used to determine whether the execution of a query or view (HFSQL Classic or Client/Server) is completed.
The 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.
The 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).
The FicCryptMethod property is used to set the encryption method of a data file.
The 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.
The FilterCondition property allows you to know the selection condition set by HFilter on a data file, HFSQL view or query.
The FilteredItem property is used to identify the item that has a filter implemented by HFilter.
The 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.
The Format property is used to define the data format of a data file.
The 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).
The GenerationNumber property is used to get the generation number of the physical data file associated with the logical data file.
The GUIDAnalysis property returns the GUID of the analysis that was used to create the data file.
The GUIDFile property returns the GUID of the file defined in the analysis that was used to create the data file.
The HugeFile property is used to configure the maximum size of a data file.
The Index property indicates the physical index (physical order) of an item in a record.
The InfoThumbnailGeneration property is used to determine if the thumbnails of an item have been generated successfully.
The InitialFile property is used to get the original name of the data file associated to an item in a query.
InitialItem 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.
The IntegerPart property is used to configure Numeric items.
The Items property is used to configure the different items of a full-text index.
Usage example of the KeyExpression property
The KeyExpression property is used to set the different components of a composite key.
The KeySize property is used to set the characteristics of a text memo key item.
The KeyType property is used to set the characteristics of a key item.
The Language property is used to set the language used to compare and sort Unicode items (Unicode Text item or Unicode Text Memo item).
The LanguageDescribed property is used to set the language used to compare and sort Unicode items (Unicode Text item or Unicode Text Memo item).
The LinkedFile property is used to set the characteristics of a link.
The LinkedKey property is used to set the characteristics of a link
The LogBackupDirectory property is used to manage the backup directory of log files.
The LogDirectory property is used to manage the directory of the log file described in the analysis.
The LogFile property is used to determine if a data file is a log file.
The 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).
ManageHTML is used to configure the management mode of the HTML format in a full-text index.
ManageRTF is used to configure the management mode of the RTF format in a full-text index.
The MaxAutoID property is used to get the maximum automatic identifier of a replicated data file.
The MaxLinkedCardinality property is used to get and modify the maximum cardinality of the related item in the link.
The MaxSourceCardinality property is used to get and modify the maximum cardinality of the source item in the link.
The MaxThumbnailHeight property is used to get and change the maximum height of a thumbnail of an Image item (binary memo).
The MaxThumbnailWidth property is used to get or change the maximum width of a thumbnail of an Image item (binary memo).
The Memo property is used to determine if an item is of type memo.
The MinAutoID property is used to get the minimum automatic identifier of a replicated data file.
The MinimumLength property is used to configure the minimum length of the words to be indexed.
The MinLinkedCardinality property is used to get and modify the minimum cardinality of the related item in the link.
The MinSourceCardinality property is used to get and modify the minimum cardinality of the source item in the link.
The MmoCryptMethod property is used to set the encryption method of the memo file (.MMO) associated with the data file.
The MmoPackMethod property is used to set the compression mode of the MMO file (containing text and binary memos) associated with the data file.
The ModificationRule property is used to configure the modification rule (integrity management) to be applied to the data file described in the code.
The 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.
NbArrayElement is used to configure the number of elements in an array item.
The NbComponent property is used to get the number of elements in a composite key.
The NbDescribedThumbnail property is used to get the number of thumbnails expected for an item.
The 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.
The 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.
The 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.
The NbThumbnail property is used to get the number of thumbnails generated for an item.
The NdxCryptMethod property is used to configure the encryption method for the index (.NDX) file associated with the data file.
The NewRecord property is used to determine if the record is a new record or if it comes from the data file.
The 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.
The NullAllowed property is used to manage the NULL value in the items of HFSQL data files.
The NullSupported property is used to manage the NULL value in HFSQL data files.
The OperationLogDirectory property is used to manage the directory of the operation log file associated with a data file.
The 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.
The PasswordProtected property is used to determine if a datafile is password-protected.
The 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).
The PhysicalName property is used to manage the physical name of HFSQL data files.
The Provider property is used to manage the type of a connection (HFSQL Client/Server, OLE DB, etc.).
The 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).
The 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.
The 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).
The 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).
The ReplicationDirectory property is used to manage the directory of replication files (".RPL" or ".RPM").
The Secure property is used to configure the security level of data file encryption.
The Server property is used to manage the data source of a connection (HFSQL Client/Server, OLE DB, etc.).
The 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).
The 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.).
The SourceFile property is used to set the characteristics of a link.
The SourceKey property is used to set the characteristics of a link.
The spAge property gets the time elapsed since the password was last changed.
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).
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).
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).
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).
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.
The SQLCode code property is used to get the SQL code of a query created with the query editor (".WDR" file).
The Stemming property is used to enable stemming and to define the language used for stemming in a full-text index defined through programming.
The StopWord property is used to define stopwords in a full-text index defined through programming.
The Synonym property is used to define synonyms in a programmatically defined full-text index.
Text is used to find out whether an item is a text item.
The TextItemCompleted property is used to manage text items in an HFSQL data file.
The 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.
The 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).
The 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).
The TransactionFile property is used to determine if a data file is a transaction file.
The 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).
The Unalterable property is used to configure the unalterability of a data file: the data file cannot be modified; only additions can be made.
The User property is used to manage the user of a connection (HFSQL Client/Server, OLE DB, etc.).
The 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).
WDD55 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.
The 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.