Home | Previous Page | Next Page   Function Descriptions >

mi_typeid_is_collection( )

The mi_typeid_is_collection( ) function determines whether a type identifier is for a collection.

Syntax

mi_boolean mi_typeid_is_collection(typeid_ptr)
   MI_TYPEID *typeid_ptr;
typeid_ptr
is 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_collection( ) function determines if the data type in the type identifier that typeid_ptr references is a collection data type. Valid collection data types are SET, MULTISET, and LIST.

Important:
The type identifier is an opaque structure. Do not access its value directly. To determine if a type identifier contains a collection data type, always use mi_typeid_is_collection( ).

Return Values

MI_TRUE
indicates that the type identifier that typeid_ptr references is a collection data type.
MI_FALSE
indicates that the type identifier that typeid_ptr references is not a collection data type.

Related Topics

See also the descriptions of mi_typeid_equals( ), mi_typeid_is_builtin( ), mi_typeid_is_complex( ), mi_typeid_is_distinct( ), mi_typeid_is_list( ), mi_typeid_is_multiset( ), mi_typeid_is_row( ), and mi_typeid_is_set( ).

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]