cwbUP_DeleteEntry

Purpose

Deletes the update entry from the update entry list.

Syntax

 
unsigned int CWB_ENTRY cwbUP_DeleteEntry(
                             cwbUP_EntryHandle entryHandle);

Parameters

cwbUP_EntryHandle entryHandle - input

Handle that was returned by a previous call to cwbUP_CreateUpdateEntryHandle, cwbUP_GetUpdateEntryHandle, or cwbUP_FindEntry.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_HANDLE

Update entry handle is not valid.

CWBUP_ENTRY_IS_LOCKED

Another application is currently changing the update entry list. No changes are allowed at this time.

Usage

After this call, you do not need to call cwbUP_FreeEntryHandle. The entry is "freed" when the entry is successfully deleted. If you retrieved the first update entry by using the cwbUP_GetEntryHandle API, and then called this API to delete the entry, all of the update entries would shift one position to fill the slot left by the delete. So, if you then wanted to get the next update item, you would pass the same index that you did on the previous cwbUP_GetEntryHandle API call.