cwbOBJ_CopyParmObjHandle

Purpose

Creates a duplicate parameter list object. All attribute keys and values in the parameter list object will be copied to the new parameter list object.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_CopyParmObjHandle(
                               cwbOBJ_ParmHandle   parmListHandle,
                               cwbOBJ_ParmHandle  *newParmListHandle,
                               cwbSV_ErrHandle     errorHandle);

Parameters

cwbOBJ_ParmHandle parmListHandle - input

Handle of the parameter list object to copy.

cwbOBJ_ParmHandle *newParmListHandle - output

Upon successful competition of this call, this handle will contain the new parameter list object handle.

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_OK

Successful completion.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory.

CWB_INVALID_HANDLE

Handle is not an allocated object handle.

Usage

The cwbOBJ_DeleteParmObjectHandle API must be called to free resources allocated by this call.