WM_GetMPSendBufferSize

C Specification

#include <nitro/wm.h>

int WM_GetMPSendBufferSize( void );

Arguments

None.

Return Values

Returns the size that is needed for the send buffer that is passed as the argument of WM_StartMP.

Description

This function looks for the size that is needed for the send buffer that the SDK uses internally for MP communication. This function can be executed only if the WM is in either the PARENT state or the CHILD state.

On the child, the return value is calculated based on the externally obtained beacon information. Therefore, when using it to allocate memory for the send buffer, be sure to either confirm that the return value of this function is an appropriate value or confirm that memory was successfully allocated after allocating the memory.

See Also

WM_StartMP, WM_GetMPReceiveBufferSize

Revision History

12/21/2005 Clearly stated that the value on the child should not be trusted.
08/18/2004 Initial version.