cwbOBJ_GetObjAttr

Purpose

Get an attribute of an object.

Syntax

 
unsigned int CWB_ENTRY cwbOBJ_GetObjAttr(
                              cwbOBJ_ObjHandle  objectHandle,
                              cwbOBJ_KeyID      key,
                              void             *buffer,
                              unsigned long     bufLen,
                              unsigned long    *bytesNeeded,
                              cwbOBJ_DataType  *keyType,
                              cwbSV_ErrHandle   errorHandle);

Parameters

cwbOBJ_ObjHandle objectHandle - input
Handle of the object to get the attribute for.
cwbOBJ_KeyID key - input
Identifying key of the attribute to retrieve. The CWBOBJ_KEY_XXX constants define the key ids. The type of object pointed to by objectHandle determine which keys are valid.
void *buffer - output
The buffer that will hold the attribute value, if this call returns successfully. The value of the key determines what type of data will be put into pBuffer. The type is also returned to the *keyType parameter, if provided.
unsigned long bufLen - input
The length of the buffer pointed to by pBuffer.
unsigned long *bytesNeeded - output
On output, this will be the number of bytes needed to hold result.
cwbOBJ_DataType *keyType - output
Optional, may be NULL. On output this will contain the type of data used to represent this attribute and what is stored at *buffer.
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.
CWBOBJ_RC_HOST_ERROR
Host error occurred. Text may be in errorHandle.
CWBOBJ_RC_INVALID_KEY
Key isn't valid.
CWB_API_ERROR
General API failure.

Usage

The following attributes may be retrieved for these object types:

Parent topic: Object APIs for iSeries Access for Windows