NPA_Unregister_Options

Deregisters the configuration options associated with an NWPA application.

Thread Context:Non-Blocking
Requirements:To deregister options on an instance basis, the module must provide the appropriate handle to the load-instance.

Syntax

    LONG NPA_Unregister_Options (
       LONG   npaHandle,
       LONG   instance
       );

Parameters

npaHandle
(IN) The CDM's or HAM's handle for using the NPA APIs, assigned during NPA_Register_CDM_Module or NPA_Register_HAM_Module, respectively.
instance
(IN) The instance number the CDM or HAM associated with the current group of options being deregistered. This instance corresponds to either a CDM's device instance or a HAM's adapter instance. This is the instance number that the CDM or HAM passed to NPA_Register_CDM_Module or NPA_Register_HAM_Module, respectively.

By setting this parameter to -1, NWPA deregisters all option instances associated with the CDM or HAM.

Return Values

The following table lists return values and descriptions.

zero

Successful

nonzero

Unsuccessful

Remarks

NPA_Unregister_Options is used to deregister the command line options associated with a module (or an instance of itself).

NPA_Unregister_Options is only to be used in the following cases:

  • After registering options during initialization, an error occurs which prevents the module instance from loading. In this case, NPA_Unregister_Options must be called before returning a nonzero completion from the HAM_Load function. See Load-Time Initialization and Registration.
  • It should be called for a specific instance during the Instance Unload function (see Instance Unload for HAMs).