cwbOBJ_GetObjID

Purpose

Get the id of an object. This is the data the uniquely identifies this object on the server. The data gotten is not readable and is binary. It can be passed back on the cwbOBJ_GetObjHandleFromID() API to get a handle back to that object.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_GetObjID(
                               cwbOBJ_ObjHandle  objectHandle,
                               void             *idBuffer,
                               unsigned long     bufLen,
                               unsigned long    *bytesNeeded,
                               cwbSV_ErrHandle   errorHandle);

Parameters

cwbOBJ_ObjHandle objectHandle - input

Handle of the object to get the ID from.

void *idBuffer - output

The buffer that will hold the ID of this object.

unsigned long bufLen - input

The length of the buffer pointed to by pIDBuffer.

unsigned long *bytesNeeded - output

On output, this will be the number of bytes needed to hold the ID.

cwbSV_ErrHandle errorHandle - output

Optional, may be 0. Any returned messages will be written to this object. It is created with the cwbSV_CreateErrHandle() API. The messages may be retrieved through the cwbSV_GetErrText() API. If the parameter is set to zero, no messages will be retrievable.

Return Codes

The following list shows common return values.

CWB_NO_ERROR

Successful completion.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory.

CWB_INVALID_HANDLE

Handle is not an allocated object handle.

CWB_BUFFER_OVERFLOW

Buffer too small.

Usage

None