cwbOBJ_GetObjAttrs

Purpose

Get several attributes of an object.

Syntax

 
unsigned int CWB_ENTRY cwbOBJ_GetObjAttrs(
                              cwbOBJ_ObjHandle        objectHandle,
                              unsigned long           numAttrs,
                              cwbOBJ_GetObjAttrParms *getAttrParms,
                              cwbSV_ErrHandle         errorHandle);

Parameters

cwbOBJ_ObjHandle objectHandle - input

Handle of the object to get the attribute for.

unsigned long numAttrs - input

number of attributes to retrieve

cwbOBJ_GetObjAttrParms *getAttrParms - input

an array of numAttrs elements that for each attribute to retrieve gives the attribute key (id), the buffer where to store the value for that attribute and the size of the 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

See the Usage Notes^® in cwbOBJ_GetObjAttr to see which attribute are valid for the various types of objects.