cwbUP_GetDescription

Purpose

Gets the description of the update entry.

Syntax

 
unsigned int CWB_ENTRY cwbUP_GetDescription(
                             cwbUP_EntryHandle entryHandle,
                             char *entryDescription,
                             unsigned long bufferLength,
                             unsigned long *actualLength);

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/output

Pointer to a buffer that will receive the description of the update entry.

unsigned long bufferLength - input

Length of the buffer. An extra byte should be included for the null termination character. If the buffer is not large enough to hold the entire description, an error will be returned and the actualLength parameter will be set to the number of bytes the entryDescription buffer needs to be to contain the data.

unsigned long * actualLength - input/output

Pointer to a length variable that will be set to the size of the buffer needed to contain the description.

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.

CWB_BUFFER_OVERFLOW

Buffer is too small to hold return data.

Usage

None