DWC_IsSendableReliable

C Specification

#include <dwc.h>

BOOL DWC_IsSendableReliable( u8 aid );

Description

Checks whether data can be sent in a "Reliable" send to the host assigned a specific AID.

This function will return FALSE when data is still being sent, or if there is little space in the send buffer. You must wait until this function returns TRUE before attempting to send data using either DWC_SendReliable or DWC_SendReliableBitmap. Note that the send buffer size is set by the DWC_InitFriendsMatch function.

This function will also return FALSE when an error is being generated.

Further, FALSE is also returned if an invalid AID is set to the argument aid, but in this case, if the AID is checked with the DWC_IsValidAID function, it can be distinguished from the previous two conditions that make sending data impossible.

Arguments

aid AID of the party to which you are sending

Return Values

TRUE Able to send.
FALSE Unable to send.

See Also

DWC_SendReliable, DWC_SendReliableBitmap, DWC_InitFriendsMatch, DWC_IsValidAID

Revision History

01/18/2006 Added "when an error is being generated" to the conditions under which the return value will return FALSE
12/16/2005 Added a detailed description of when the return value returns FALSE
11/02/2005 Initial version