WVR_TerminateAsync

Syntax

#include <nitro/wvr.h>

WVRResult WVR_TerminateAsync(
    WVRCallbackFunc callback ,
    void*           arg
);

Arguments

callback Callback function to call when the asynchronous process completes. This callback is called from inside the interrupt handler.
arg Optional arguments to be passed to the callback function called when the asynchronous process is complete.

Return Values

Returns the results of the WVRResult enumerated type process.

Description

Forcibly stops the wireless driver that is operating on the ARM7 side and deallocates the VRAM bank it was using. If the return value was WVR_RESULT_OPERATING, the callback function is called from inside the PXI receive interrupt handler when the asynchronous process is complete.
This function is relevant only when the ichneumon or ichneumon.TWL components, which contains features for operating the wireless driver in VRAM, are being used. For all other components, WVR_RESULT_DISABLE is returned, and this function fails. If the ichneumon/ichneumon.TWL component is being used, stops the driver only if the wireless driver has been started by the WVR_StartUpAsync function.

If the asynchronous process for this component completes as expected, the wireless communication features become unusable. If the communications process was running using the WM library after the driver was started up via the WVR_StartUpAsync function, the internal state of the WM library will forcibly be put into a READY state. Until the wireless driver is restarted via the WVR_StartUpAsync function again, subsequent WM asynchronous operation functions will return WM_ERRCODE_DISABLE to the callbacks. This does not mean that the WM library will be reset to a "pre-initialization state."Call the WM_Finish function inside the callback of this function when you need to completely shut down the WM library.

See Also

WVR_StartUpAsync
WM_Finish

Revision History

2009/06/15 Added description related to the ichneumon.TWL component.
2005/06/27 Added statement about callback being called from the interrupt handler.
2005/03/14 Corrected mistake with link destination.
2005/03/08 Standardized the use of the term "interrupt" in Japanese.
2005/03/01 Added to Description.
2005/02/16 Initial version.


CONFIDENTIAL