CWBSO_ResetParmObj

Purpose

Resets a parameter object to remove any attribute values from the object.

Syntax

 
unsigned int CWB_ENTRY CWBSO_ResetParmObj(
                CWBSO_PARMOBJ_HANDLE parmObjHandle);    

Parameters

CWBSO_PARMOBJ_HANDLE parmObjHandle - input
A handle to a parameter object that was returned by a previous call to CWBSO_CreateParmObjHandle.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR
No error occurred.
CWBSO_BAD_PARMOBJ_HANDLE
The parameter object handle is not valid.

Usage

CWBSO_CreateParmObjHandle must be called prior to calling this API. The parameter object handle that is returned by CWBSO_CreateParmObjHandle must be passed as input to this API.