NPA_Register_Options

Registers options that have been parsed out from the command line, and, for those modules that support it, initiates hot replacement.

Thread Context:Blocking
Requirements:This function must be called only from a blocking process level. When used correctly, this function is called within the context of the module's initialization function (CDM_Load or HAM_Load), which is a blocking process.

Syntax

    LONG NPA_Register_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 intends to associate with the current group of options being registered. This instance corresponds to either a CDM's device instance or a HAM's adapter instance. This instance number was what the CDM or HAM passed to NPA_Register_CDM_Module or NPA_Register_HAM_Module, respectively.

Return Values

The following table lists return values and descriptions.

zero

Successful

nonzero

Unsuccessful

Remarks

NPA_Register_Options is used to register the command line options allowed by a CDM or HAM. These options can be custom parameters, or as in the case of the HAM, they can specify the interrupt, port, and DMA range values allowed by the HAM. Command line options can be anything needed by the CDM or HAM, such as custom initialization parameters. NPA_Register_Options must be called during CDM or HAM initialization within the context of CDM_Load or HAM_Load. Any data structures required by the module should be allocated prior to making this call, because after this function returns, the module must be ready to accept I/O requests.