HAM_Software_Hot_Replace

The HAM's entry point for exchanging configuration information with a newer version HAM.

Thread Context:Non-Blocking

Syntax

    LONG HAM_Software_Hot_Replace (
       LONG   messageLength,
       void  *message
       );

Parameters

messageLength
(IN) NWPA passes the value of this parameter, which is the length in bytes of the data being passed between the modules.
message
(IN) NWPA passes the value of this parameter, which is a pointer to the buffer containing the data to be passed.

Return Values

The following table lists return values and descriptions.

zero

Successful

Remarks

HAM_Software_Hot_Replace is the entry point that NPA_Exchange_Message uses to pass data between a HAM already in server memory and the HAM being newly loaded to replace it. This function is registered with NWPA during NPA_Register_HAM_Module. NPA_Exchange_Message is the channel that links the respective hot replace entry points for each HAM. Through this entry point, the replacement HAM can request configuration information from the HAM being replaced so that the new HAM can simply take the old HAM's place and be immediately operational.

WARNING:Because the older version of the HAM will be removed from memory, data-passing between the two modules must be done by handles or indexes to avoid passing bad memory pointers.