cwbOBJ_ResetListAttrsToRetrieve

Use the cwbOBJ_ResetListAttrsToRetrieve API with this product.

Purpose

Resets the list attributes to retrieve information to its default list.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_ResetListAttrsToRetrieve(
                               cwbOBJ_ListHandle   listHandle,
                               cwbSV_ErrHandle     errorHandle);

Parameters

cwbOBJ_ListHandle listHandle - input: List handle to reset.
cwbSV_ErrHandle errorHandle - output: Optional, may be 0. Any returned messages will be written to this object. It is created with the cwbSV_CreateErrHandle() API. The messages may be retrieved through the cwbSV_GetErrText() API. If the parameter is set to zero, no messages will be retrievable.

Return Codes

The following list shows common return values.

CWB_OK: Successful completion
CWB_INVALID_HANDLE: Handle is not an allocated list handle.

Usage

Use this call to reset the list handle's list of attributes to retrieve after calling cwbOBJ_SetListAttrsToRetrieve().