Returns attribute information for .DLD file.
Syntax
intl DlFileGetAttribute (DlFileId hFile, DlFileAttribute which, char *buffer, intl bufSize)
Arguments
hFile
Handle to data file object, as returned by DlFileOpen. Input
which
The specific attribute to return. Input
DlFileAttribute Enums | Description |
---|---|
DlKeyType | Numeric type of key (see below) |
DlNumFields | Number of fields in file |
DlNumValues | Maximum number of values per field |
DlFileDescription | Long (256 character) description of file |
DlKeyFieldName | Name of key field |
DlKeyLimit | If 1, limits keys to alphanumeric characters |
DlKeyType is returned as one of the following values:
DlKeyType | Description |
---|---|
DL_TYPE_ZIP | ZIP Code |
DL_TYPE_ZIP4 | ZIP+4 Code |
DL_TYPE_CTY | County |
DL_TYPE_CT | Census tract |
DL_TYPE_BG | Block group |
DL_TYPE_BLK | Block |
*buffer
Location to store the returned data. Output
bufSize
Maximum size of data to return in buffer. Input
Return Value
Returns TRUE if attribute is a string and the value was copied to buffer, or a number if attribute is numeric.
Notes
DlFileGetAttribute is used to retrieve attribute information about a specified .DLD file. This may include such information as field name and description, field size, and data types.