DWC_CheckDirtyFlag

C Specification

#include <dwc.h>

BOOL DWC_CheckDirtyFlag( const DWCUserData* userdata );

Description

When user data has been changed, this function checks the dirty flag of the valid DWCUserData structure. The dirty flag may be updated only when the login completion callback is called after the DWC_LoginAsync function has been used.

Even in those cases when the login completion callback is not called, have the application check this flag every time the game data is saved, and if the dirty flag is enabled, have the application save the user data.

Before saving, always call the DWC_ClearDirtyFlag function and clear the dirty flag.

Arguments

userdata Pointer to the DWCUserData structure where user data is stored.

Return Values

TRUE The dirty flag is enabled (user data has been changed).
FALSE The dirty flag is disabled (user data remains unchanged).

See Also

DWC_CreateUserData, DWC_ClearDirtyFlag, DWC_LoginAsync

Revision History

12/16/2005 Added about clearing the dirty flag before saving.
10/20/2005 Initial version.