The mi_typeid_is_list() function
The mi_typeid_is_list() function determines whether a type identifier is for a LIST collection data type.
Syntax
mi_boolean mi_typeid_is_list(typeid_ptr)
MI_TYPEID *typeid_ptr;
- typeid_ptr
- A pointer to the type identifier to check.
Valid in client LIBMI application? | Valid in user-defined routine? |
---|---|
Yes | Yes |
Usage
The mi_typeid_is_list() function
determines if the data type in the type identifier that typeid_ptr references
is a LIST collection data type.
Important: The type identifier
is an opaque structure. Do not access its value directly. To determine
if a type identifier contains a LIST data type, always use mi_typeid_is_list().
To determine if a type identifier contains any collection data type,
including LIST, use the mi_typeid_is_collection() function.
Return values
- MI_TRUE
- The type identifier that typeid_ptr references is a LIST data type.
- MI_FALSE
- The type identifier that typeid_ptr references is not a LIST data type.