The mi_row_desc_create() function
The mi_row_desc_create() function creates a row descriptor from a specified type identifier.
Syntax
MI_ROW_DESC *mi_row_desc_create(typeid)
MI_TYPEID *typeid;
- typeid
- A pointer to the type identifier for the data type of the row descriptor to create.
Valid in client LIBMI application? | Valid in user-defined routine? |
---|---|
No | Yes |
Usage
The mi_row_desc_create() function creates a row descriptor for the row type that the typeid type identifier specifies. This function is the constructor function for the row descriptor.
Server only: In
a C UDR, the row structure and row descriptor are part of the same
data structure. The row structure is just a data buffer in the row
descriptor that holds copies of the column values of a row. The mi_row_desc_create() function
allocates a row descriptor with a NULL-valued pointer for the row
structure. Use the mi_row_create() function to
add the data buffer to the row descriptor.
The mi_row_desc_create() function allocates a new row descriptor with the current memory duration.
Client only: In a client LIBMI application,
the row structure and row descriptor are separate data structures.
Return values
- An MI_ROW_DESC pointer
- A pointer to a row descriptor for the specified data type.
- NULL
- The function was not successful.