WM_SetMPChildSize

C Specification

#include <nitro/wm.h>

WMErrCode WM_SetMPChildSize(
WMCallbackFunc  callback ,
u16             childSize
);

Arguments

callback Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.
childSize Specifies the child send capacity. This value is rounded up to a multiple of 2.

Return Values

Returns the results of the WMErrCode enumerated type process.

Description

Sets the child send capacity. The send capacity must be a multiple of 2, so if an odd number is designated, it is rounded up so that it is even. Be sure to use this function after referring to the "Wireless Communication Library Description" for thorough understanding.

The child send capacity is initialized by the WM_StartParent or WM_StartConnect function. This cannot be reset to a value larger than the initial value.

This wrapper function calls the WM_SetMPParameter function internally.

See Also

WM_SetMPParameter, WM_StartMP, WM_SetMPDataToPort

Revision History

12/08/2005 Clearly stated that the send capacity must be an even number.
11/24/2005 Initial version.