NWC24SearchMsgs

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24SearchMsgs(
    NWC24MsgObj* msgObjArray,
    u32          arraySize,
    u32*         numStored,
    u32*         numRemain
);

Description

Performs a message search and stores the obtained results in an array in NWC24MsgObj format.
When the results are more numerous than the array size specified in arraySize, the number of remaining elements is returned in numRemain; those are stored the next time this function is called. All of the search results can be gotten by repeatedly calling this function (without initializing in between calls) until numRemain is 0.

Arguments

`msgObjArray`	A pointer to the start of the NWC24MsgObj array that stores the search results.
`arraySize`	The number of elements in the array specified by `msgObjArray`.
`numStored`	A pointer to a u32 variable that returns the number of stored results.
`numRemain`	A pointer to a u32 variable that returns the remaining number of results.

Return Values

NWC24_OK: Normal exit (search results are stored in an array, values are returned in numStored and numRemain).
NWC24_ERR_LIB_NOT_OPENED: Library not open.
NWC24_ERR_NULL: The msgObjArray value is a null pointer, even though arraySize is not zero.
NWC24_ERR_FILE_*: File access error.

Revision History

2007/09/03 Added NWC24SetSearchCondPublic to the See Also section.
2006/09/01 Initial version.

CONFIDENTIAL