CWBSO_CreateParmObjHandle

Purpose

Creates a parameter object and returns a handle to the object. A parameter object contains a set of parameter IDs and values which may be passed as input to other APIs.

Syntax

 
unsigned int CWB_ENTRY CWBSO_CreateParmObjHandle(
                CWBSO_PARMOBJ_HANDLE far* lpParmObjHandle); 

Parameters

CWBSO_PARMOBJ_HANDLE far* lpParmObjHandle - output

A long pointer to a handle which will be set to the handle for the new parameter object.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR

No error occurred.

CWBSO_LOW_MEMORY

Not enough memory is available for the request.

Usage

When the parameter object is no longer needed, the calling program is responsible for doing the following:

• Call CWBSO_DeleteParmObjHandle to free up resources that are allocated on the client.