function
|
SQLGetDescField
|
|
Library: omodbc - low-level ODBC support
Include: omodbc.xin
|
Return type: Integer
Returns: An SQL return code. The following values may be returned:
- SQL_SUCCESS (the current field setting).
- SQL_SUCCESS_WITH_INFO (the current field setting, but a message was issued).
- SQL_ERROR (an error occurred).
- SQL_INVALID_HANDLE (the handle is invalid).
- SQL_NO_DATA (no data is available).
|
Declaration define external integer function SQLGetDescField
( read-only SQL_handle_type DescriptorHandle,
value integer RecNumber,
value integer FieldIdentifier,
read-only SQL_vector_type Value,
value integer BufferLength,
modifiable integer StringLength )
Purpose
Returns the current setting of a single field of a descriptor record.
Input arguments:
- DescriptorHandle.
- RecNumber. Indicates the descriptor record from which the application seeks information. Descriptor records are numbered from zero; record number 0 is the bookmark record. If the FieldIdentifier argument indicates a header field, RecNumber is ignored. If the row does not contain data for a column or parameter, the default values of the field are returned.
- FieldIdentifier. Indicates the field of the descriptor whose value is to be returned. The following values are allowed:
- SQL_DESC_COUNT
- SQL_DESC_TYPE
- SQL_DESC_LENGTH
- SQL_DESC_OCTET_LENGTH_PTR
- SQL_DESC_PRECISION
- SQL_DESC_SCALE
- SQL_DESC_DATETIME_INTERVAL_CODE
- SQL_DESC_NULLABLE
- SQL_DESC_INDICATOR_PTR
- SQL_DESC_DATA_PTR
- SQL_DESC_NAME
- SQL_DESC_UNNAMED
- SQL_DESC_OCTET_LENGTH
- SQL_DESC_ALLOC_TYPE
- SQL_DESC_ARRAY_SIZE
- SQL_DESC_ARRAY_STATUS_PTR
- SQL_DESC_BASE_COLUMN_NAME
- SQL_DESC_BASE_TABLE_NAME
- SQL_DESC_BIND_OFFSET_PTR
- SQL_DESC_BIND_TYPE
- SQL_DESC_DATETIME_INTERVAL_PRECISION
- SQL_DESC_LITERAL_PREFIX
- SQL_DESC_LITERAL_SUFFIX
- SQL_DESC_LOCAL_TYPE_NAME
- SQL_DESC_MAXIMUM_SCALE
- SQL_DESC_MINIMUM_SCALE
- SQL_DESC_NUM_PREC_RADIX
- SQL_DESC_PARAMETER_TYPE
- SQL_DESC_ROWS_PROCESSED_PTR
- Value. The requested descriptor information.
- BufferLength. The maximum length of Value.
Output argument:
- StringLength. The returned length of Value.
Generated: August 11, 2000 at 3:07:56 pm
If you have any comments about this section of the documentation, send email to docerrors@omnimark.com
Copyright © OmniMark Technologies Corporation, 1988-2000.