The mi_get_vardata_align() function
The mi_get_vardata_align() accessor function obtains a pointer to the data in a varying-length structure (such as mi_lvarchar) and adjusts for any initial padding required to align the data.
Syntax
char *mi_get_vardata_align(varlen_ptr, align)
mi_lvarchar *varlen_ptr,
mi_integer align;
- varlen_ptr
- A pointer to a variable-length structure.
- align
- The alignment boundary value.
Valid in client LIBMI application? | Valid in user-defined routine? |
---|---|
Yes | Yes |
Usage
The data in a varying-length structure is not null terminated. Do not use null termination to determine end of the data that the mi_get_vardata_align() returns. Instead, use the mi_get_varlen() function to obtain the actual data length, which you can then use to access the varying-length data.
Although the varlen_ptr argument is declared as a pointer to an mi_lvarchar, you can also use the mi_get_vardata_align() function to obtain aligned data from other varying-length data types, such as mi_sendrecv.
Return values
- A char pointer
- A pointer to the data in the varying-length structure.
- NULL
- The function was not successful.