cwbUP_CreateUpdateEntry

Purpose

Creates a new update entry and passes back a handle to it.

Syntax

 
unsigned int CWB_ENTRY cwbUP_CreateUpdateEntry(
                             char * entryDescription,
                             char * entrySource,
                             char * entryTarget,
                             cwbUP_EntryHandle *entryHandle);

Parameters

char * entryDescription - input

Points to a null-terminated string that contains a description to identify the update entry.

char * entrySource - input

Points to a null-terminated string that contains the source for the update entry. This can be either a drive and path, or a UNC name.

char * entryTarget - input

Points to a null-terminated strings that contains the target for the update entry. This can be either a drive and path, or a UNC name.

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 passed as an address.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory to create handle.

CWBUP_TOO_MANY_ENTRIES

The maximum number of update entries already exist. No more can be created.

CWBUP_STRING_TOO_LONG

An input 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

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.