DlFileGetAttribute - demographics_library - 2024.01

Demographics Library Reference for Windows and UNIX

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > Demographics Library
Version
2024.01
Language
English
Product name
Demographics Library
Title
Demographics Library Reference for Windows and UNIX
Copyright
2024
First publish date
1994
Last updated
2024-05-17
Published on
2024-05-17T02:16:20.391253

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

Note: If the data returned by buffer is larger than the space allotted by bufSize, it will be truncated.

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.