The mi_lo_lolist_create() function
The mi_lo_lolist_create() function converts an array of LO handles into an MI_LO_LIST structure.
Syntax
mi_integer mi_lo_lolist_create(conn, LOhdl_cnt, LO_hdls, LO_list)
MI_CONNECTION *conn;
mi_integer LOhdl_cnt;
MI_LO_HANDLE **LO_hdls;
MI_LO_LIST **LO_list ;
- conn
- This value is one of the following connection values:
A pointer to a connection descriptor established by a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect().
A NULL-valued pointer (database server only)
- LO_hdl_cnt
- The number of LO handles in the LO_hdls array.
- LO_hdls
- A pointer to an array of LO handles that mi_lo_lolist_create() converts.
- LO_list
- A pointer to the MI_LO_LIST structure that mi_lo_lolist_create() creates.
Valid in client LIBMI application? | Valid in user-defined routine? |
---|---|
No | Yes |
Usage
- When the LO_list value points to NULL, this function allocates an MI_LO_LIST structure.
- When the LO_list value does not point to NULL, the mi_lo_lolist_create() function assumes that LO_list points to memory that has already been allocated by a previous call to mi_lo_lolist_create().
The mi_lo_lolist_create() function allocates a new MI_LO_LIST structure in the current memory duration. The function then initializes the MI_LO_LIST structure with the LO handles, which LO_hdls indicates. It converts the number of LO handles that the LOhdl_cnt argument specifies.
- Assign time (when any assign() support function would execute)
- Destroy time (when any destroy() support function would execute)
- Import time (when any import support function would execute)
Return values
- >0
- The number of bytes of the MI_LO_LIST structure.
- 0
- The function was not successful.