cwbUP_GetEntryHandle

Purpose

Gets a handle to an existing update entry at a given position in the list.

Syntax

 
unsigned int CWB_ENTRY cwbUP_GetEntryHandle(
                             unsigned long entryPosition,
                             cwbUP_EntryHandle *entryHandle);

Parameters

unsigned long entryPosition - input

Index into the update entry list of the entry for which you want to retrieve a handle. (Pass in 1 if you wish to retrieve the first update entry)

cwbUP_EntryHandle * entryHandle - input/output

Pointer to a cwbUP_EntryHandle where the handle will be returned. This handle must be used in subsequent calls to the update entry APIs.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_POINTER

NULL was passed as an address.

CWBUP_ENTRY_NOT_FOUND

No update entry at the given position.

CWBUP_POSITION_INVALID

Position that is given is not in range.

Usage

The handle that is returned from this call will be used for accessing the update entry with other Update APIs. When you use this call, and have completed your processing of the update entry, you must call cwbUP_FreeEntryHandle. This call will "unlock" the entry, and free resources that are associated with it. You must call cwbUP_FreeEntryHandle once for each time that you call an API that returns an entry handle.