DWC_IsSendableReliable

Syntax

#include <dwc.h>

BOOL DWC_IsSendableReliable( u8 aid );

Description

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

This function returns FALSE if 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 with DWC_SendReliable or DWC_SendReliableBitmap. Note that the send buffer size is set by the DWC_InitFriendsMatch function. Because this function returns FALSE in that case, make sure not to send until this function returns TRUE.

This function also returns FALSE when an error is being generated.

This function returns FALSE if an invalid AID is passed to the argument aid. In this case, if the AID is checked with the DWC_IsValidAID function, this condition can be distinguished from the previous two conditions that make it impossible to send data.

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

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


CONFIDENTIAL