OpenAPI User Guide > OpenAPI User Guide > OpenAPI Function Reference > OpenAPI Functions > IIapi_setDescriptor() Function--Send Information About Data Format
Was this helpful?
IIapi_setDescriptor() Function--Send Information About Data Format
The IIapi_setDescriptor() function sends information about the format of data that will be provided with the IIapi_putParms() or IIapi_putColumns() function. Parameters to IIapi_setDescriptor() contain the number of columns being inserted or copied to the database, as well as their data type, length, precision, and scale.
Sends information to the server about the format of data to be provided in subsequent calls to IIapi_putParms() and IIapi_putColumns().
This function has the following syntax:
II_VOID IIapi_setDescriptor
       (IIAPI_SETDESCRPARM *setDescrParm);
typedef struct _IIAPI_SETDESCRPARM
{
       IIAPI_GENPARM       sd_genParm;
       II_PTR              sd_stmtHandle;
       II_LONG             sd_descriptorCount;
       IIAPI_DESCRIPTOR    *sd_descriptor;
} IIAPI_SETDESCRPARM;
This function has the following parameters:
sd_genParm
Type: input and delayed output
Specifies the generic parameters. For a description, see Generic Parameters).
sd_stmtHandle
Type: input
Specifies the statement handle identifying the query.
sd_descriptorCount
Type: input
Specifies the number of columns being described by sd_descriptor.
sd_descriptor
Type: input
Specifies an array of buffers containing the descriptions of the columns. The number of buffers in this array must be equal to the sd_descriptorCount value. Each buffer includes the data type, length, precision, and scale.
Last modified date: 04/03/2024