cwbUP_SetDescription

Purpose

Sets the description of the update entry.

Syntax

 
unsigned int CWB_ENTRY cwbUP_SetDescription(
                             cwbUP_EntryHandle entryHandle,
                             char *entryDescription);

Parameters

cwbUP_EntryHandle entryHandle - input

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

char * entryDescription - input

Pointer to a null-terminated string that contains the full description to be associated with the update entry.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_HANDLE

Update entry handle is not valid.

CWB_INVALID_POINTER

NULL passed as an address parameter.

CWBUP_STRING_TOO_LONG

The description string is longer than the maximum of CWBUP_MAX_LENGTH.

CWBUP_ENTRY_IS_LOCKED

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

Usage

None