ENCSetAlternativeCharacter

Syntax

#include <revolution/enc.h>

ENCResult ENCSetAlternativeCharacter(ENCContext* context, u16 nomap, u16 invalid);

Arguments

context Character code conversion context.
nomap Substitute characters for inconvertible characters corresponding to ENC_ERR_NO_MAP_RULE.
Specified in the character code of the internal character encoding.
Specify ENC_ALT_STOP if stopping without replacing characters with their substitutes, and ENC_ALT_SKIP if skipping to next character without replacing.
invalid Substitute character for unsupported input character code corresponding to ENC_ERR_INVALID_FORMAT.
Specified in the character code of the internal character encoding.
Specify ENC_ALT_STOP if stopping without replacing characters with their substitutes, and ENC_ALT_SKIP if skipping to next character without replacing.

Return Values

ENC_OK: Normal exit.
ENC_ERR_INVALID_PARAM: Invalid argument.

Description

Specifies how non-convertible characters are handled.

When replacing with a substitute character, it is specified with a character code of the internal character encoding.
Also, the substitute character needs to be convertible to an external character encoding.

Specify ENC_ALT_STOP if stopping without replacing characters with their substitutes, and ENC_ALT_SKIP if skipping to next character without replacing.

The default setting is ENC_ALT_STOP.

See Also

None.

Revision History

2006/10/26 Initial version.


CONFIDENTIAL