CWBSO_SetObjAttr

Purpose

Sets the value of one or more attributes of an object.

Syntax

 
unsigned int CWB_ENTRY CWBSO_SetObjAttr(
                CWBSO_OBJ_HANDLE objectHandle,          
                CWBSO_PARMOBJ_HANDLE parmObjHandle,     
                unsigned short far* lpusErrorIndex,     
                CWBSO_ERR_HANDLE errorHandle);          

Parameters

CWBSO_OBJ_HANDLE objectHandle - input

A handle to an object that was returned by a previous call to CWBSO_GetObjHandle or CWBSO_CopyObjHandle.

CWBSO_PARMOBJ_HANDLE parmObjHandle - input

A handle to a parameter object that was returned by a previous call to CWBSO_CreateParmObjHandle. The parameter object contains the attributes that are to be changed for the object.

unsigned short far* lpusErrorIndex - output

If an error occurred, this value will be set to the index of the parameter item that caused the error. The first parameter item is 1. This value will be set to 0 if none of the parameter items were in error.

CWBSO_ERR_HANDLE errorHandle - input

A handle to an error object. If an error occurs that there is error text for, this handle may be used to retrieve the error message and message help.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR

No error occurred.

CWBSO_BAD_OBJECT_HANDLE

The object handle that is specified is not valid.

CWBSO_BAD_PARMOBJ_HANDLE

The parameter object handle that is specified is not valid.

CWBSO_BAD_ERR_HANDLE

The error handle that is specified is not valid.

CWBSO_CANNOT_CHANGE_ATTRIBUTE

Attribute is not changeable at this time.

CWBSO_LOW_MEMORY

Not enough memory is available for the request.

CWBSO_ERROR_OCCURRED

An error occurred. Use error handle for more information.

Usage

CWBSO_GetObjHandle or CWBSO_CopyObjHandle must be called prior to calling this API. The object handle that is returned by CWBSO_GetObjHandle or CWBSO_CopyObjHandle must be passed as input to this API. CWBSO_CreateErrorHandle must be called prior to calling this API. The error handle that is returned by CWBSO_CreateErrorHandle must be passed as input to this API.