cwbUP_GetLockHolderName

Purpose

Gets the name of the program that currently has the update entries in a locked state.

Syntax

 
unsigned int CWB_ENTRY cwbUP_GetLockHolderName(char *lockHolder,
                                               unsigned long bufferLength,
                                               unsigned long *actualLength);

Parameters

char * lockHolder - input/output

Pointer to a buffer that will receive the name of the application that is currently locking the update entries.

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 name, an error will be returned and the actualLength parameter will be set to the number of bytes the lockHolder 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 application name.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_POINTER

NULL passed as an address parameter.

CWB_BUFFER_OVERFLOW

Buffer is too small to hold return data.

Usage

None