Home | Previous Page | Next Page   Function Descriptions >

mi_error_desc_is_copy( )

The mi_error_desc_is_copy( ) function determines whether the specified error descriptor is a user copy.

Syntax

mi_integer mi_error_desc_is_copy(err_desc)
   MI_ERROR_DESC *err_desc;
err_desc
is a pointer to the error descriptor to examine.
Valid in Client LIBMI Application? Valid in User-Defined Routine?
Yes Yes

Usage

The mi_error_desc_is_copy( ) function determines whether the err_desc error descriptor is a user copy. A user copy of an error descriptor is one that the mi_error_desc_copy( ) function has allocated. The mi_error_desc_destroy( ) function returns an error if you attempt to deallocate a system-allocated error descriptor. Use this function to determine when to perform deallocation of an error descriptor with mi_error_desc_destroy( ).

An invalid error descriptor can cause the mi_error_desc_is_copy( ) function to fail.

Return Values

MI_TRUE
indicates that the error descriptor that err_desc references is a user copy.
MI_FALSE
indicates that the error descriptor that err_desc references is not a user copy.
MI_ERROR
indicates that the function was not successful.

Related Topics

See also the descriptions of mi_errmsg( ), mi_error_desc_copy( ), mi_error_desc_destroy( ), mi_error_desc_finish( ), mi_error_desc_next( ), mi_error_level( ), mi_error_sql_state( ), and mi_error_sqlcode( ).

For a general discussion of how to determine if an error descriptor is a copy, see the IBM Informix: DataBlade API Programmer's Guide.

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