FSGetEmulatedError

Syntax

#include <cafe/fs.h>

FSError FSGetEmulatedError(FSClient *client);

Parameters

client Client to get emulated error.

Return Values

Negative value (< 0) Error code to emulate.
FS_STATUS_OK No emulation is set.
Positive value (> 0) Failed to get emulated error code.
1 client is invalid address.

Description

Gets error code to be emulated with specified client.

If no error emulation is set, FS_ERROR_OK returned. Since this function returns a negative value if successful, it returns a positive value if it failed to get emulated error code.

Do Not Call From

Production code Do not call this function in production code. It is available only for debugging purposes.

See Also

Debug
FSSetEmulatedError
FSError

Revision History

2013/05/08 Automated cleanup pass.
2012/08/27 Added the warning about calling this function in the retail version.
2012/08/16 Initial version.


CONFIDENTIAL