SFXShiftJIS

Class for processing a Shift_JIS character.

#include <SFXShiftJIS.h.hpp>

class SFXShiftJIS;

SFMTYPEDEFCLASS(SFXShiftJIS)

Description

The SFXShiftJIS class is used to convert a Hiragana character into a Katakana one and vice versa, convert a 2 byte character into a 1 byte one and vice versa, etc. And the SFXShiftJIS class has only static functions.

The argument type of function of SFXShiftJIS class is SFXWideString.

In order to process a SFXAnsiString object with a function of SFXShiftJIS class, it is necesary to convert it into a SFXWideString object.

Member

Public Functions
static `UInt16`	AsUInt16( `WChar` param ) Get the comparable UInt16 value converted from the specified WChar character.
static `WChar`	AsWChar( `UInt16` param ) Get the Wide character converted from the comparable UInt16 value.
static `SFCError`	HiraganaToKatakana( `SFXWideStringPtr` param ) Convert the specified string from Hiragana into Katakana.
static `Bool`	IsFullAlpha( `WChar` param ) Check whether or not the specified character is a full-size alphabet.
static `Bool`	IsFullDigit( `WChar` param ) Check whether or not the specified character is a full-size digit.
static `Bool`	IsFullHiragana( `WChar` param ) Check whether or not the specified character is a full-size Hiragana.
static `Bool`	IsFullKatakana( `WChar` param ) Check whether or not the specified character is a full-size Katakana.
static `Bool`	IsFullSymbol( `WChar` param ) Check whether or not the specified character is a full-size symbol.
static `Bool`	IsHalfAlpha( `WChar` param ) Check whether or not the specified character is a half-size alphabet.
static `Bool`	IsHalfDigit( `WChar` param ) Check whether or not the specified character is a half-size digit.
static `Bool`	IsHalfKatakana( `WChar` param ) Check whether or not the specified character is a half-size Katakana.
static `Bool`	IsHalfSymbol( `WChar` param ) Check whether or not the specified character is a half-size symbol.
static `Bool`	IsPassword( `WChar` param ) Check whether or not the specified character is the special character for inputing a passwword.
static `SFCError`	KatakanaToHiragana( `SFXWideStringPtr` param ) Convert the specified string from Katakana into Hiragana.
static `SFCError`	ToFullAlpha( `SFXWideStringPtr` param ) Convert the specified string from half-size alphabet into full-size alphabet.
static `SFCError`	ToFullDigit( `SFXWideStringPtr` param ) Convert the specified string from half-size digit into full-size digit.
static `SFCError`	ToFullKatakana( `SFXWideStringPtr` param ) Convert the specified string from half-size Katakana into full-size Katakana.
static `SFCError`	ToFullSymbol( `SFXWideStringPtr` param ) Convert the specified string from half-size alphabet into full-size alphabet.
static `SFCError`	ToHalfAlpha( `SFXWideStringPtr` param ) Convert the specified string from full-size alphabet into half-size alphabet.
static `SFCError`	ToHalfDigit( `SFXWideStringPtr` param ) Convert the specified string from full-size digit into half-size digit.
static `SFCError`	ToHalfKatakana( `SFXWideStringPtr` param ) Convert the specified string from full-size Katakana into half-size Katakana.
static `SFCError`	ToHalfSymbol( `SFXWideStringPtr` param ) Convert the specified string from full-size symbol into half-size symbol.
static `SFCError`	ToPassword( `SFXWideStringPtr` param ) Convert the specified string into the password string with the special character.

SFXShiftJIS::AsUInt16

Get the comparable UInt16 value converted from the specified WChar character.

[ public, static ]
UInt16 AsUInt16(
    WChar param   // character to convert
);

Description

This function gets the comparable UInt16 value converted from the specified WChar character.

	Note
When the Shift_JIS character is converted into the Wide character with BREW API, consecutive character codes cannot be compared since the endian of the WChar character gets reversed. Concretely, this function will return the WChar character at it is if its code is less tha or equals 0xFF. Otherwise, it will return the endian-swapped value of the WChar character.

Note

When the Shift_JIS character is converted into the Wide character with BREW API, consecutive character codes cannot be compared since the endian of the WChar character gets reversed.

Concretely, this function will return the WChar character at it is if its code is less tha or equals 0xFF. Otherwise, it will return the endian-swapped value of the WChar character.

Reference

SFXShiftJIS::AsWChar

SFXShiftJIS::AsWChar

Get the Wide character converted from the comparable UInt16 value.

[ public, static ]
WChar AsWChar(
    UInt16 param   // value to compare
);

Description

This function gets the Wide character converted from the comparable UInt16 value.

	Note
	This function performs the inversion operation of the `SFXShiftJIS::AsUInt16` function.

Reference

SFXShiftJIS::AsUInt16

SFXShiftJIS::HiraganaToKatakana

Convert the specified string from Hiragana into Katakana.

[ public, static ]
SFCError HiraganaToKatakana(
    SFXWideStringPtr param   // string to convert
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM

Description

This function converts the specified string from Hiragana into Katakana.

Reference

SFXShiftJIS::KatakanaToHiragana

SFXShiftJIS::IsFullAlpha

Check whether or not the specified character is a full-size alphabet.

[ public, static ]
Bool IsFullAlpha(
    WChar param   // character to check
);

Return value

If the specified character is a full-size alphabet: true
Otherwise: false

Description

This function checks whether or not the specified character is a full-size alphabet.

Reference

SFXShiftJIS::IsHalfAlpha

SFXShiftJIS::IsFullDigit

Check whether or not the specified character is a full-size digit.

[ public, static ]
Bool IsFullDigit(
    WChar param   // character to check
);

Return value

If the specified character is a full-size digit: true
Otherwise: false

Description

This function checks whether or not the specified character is a full-size digit.

Reference

SFXShiftJIS::IsHalfDigit

SFXShiftJIS::IsFullHiragana

Check whether or not the specified character is a full-size Hiragana.

[ public, static ]
Bool IsFullHiragana(
    WChar param   // character to check
);

Return value

If the specified character is a full-size Hiragana: true
Otherwise: false

Description

This function checks whether or not the specified character is a full-size Hiragana.

Reference

SFXShiftJIS::IsFullKatakana

SFXShiftJIS::IsFullKatakana

Check whether or not the specified character is a full-size Katakana.

[ public, static ]
Bool IsFullKatakana(
    WChar param   // character to check
);

Return value

If the specified character is a full-size Katakana: true
Otherwise: false

Description

This function checks whether or not the specified character is a full-size Katakana.

Reference

SFXShiftJIS::IsHalfKatakana | SFXShiftJIS::IsFullHiragana

SFXShiftJIS::IsFullSymbol

Check whether or not the specified character is a full-size symbol.

[ public, static ]
Bool IsFullSymbol(
    WChar param   // character to check
);

Return value

If the specified character is a full-size symbol: true
Otherwise: false

Description

This function checks whether or not the specified character is a full-size symbol.

Reference

SFXShiftJIS::IsHalfSymbol | SFXShiftJIS::ToHalfSymbol

SFXShiftJIS::IsHalfAlpha

Check whether or not the specified character is a half-size alphabet.

[ public, static ]
Bool IsHalfAlpha(
    WChar param   // character to check
);

Return value

If the specified character is a half-size alphabet: true
Otherwise: false

Description

This function checks whether or not the specified character is a half-size alphabet.

Reference

SFXShiftJIS::IsFullAlpha

SFXShiftJIS::IsHalfDigit

Check whether or not the specified character is a half-size digit.

[ public, static ]
Bool IsHalfDigit(
    WChar param   // character to check
);

Return value

If the specified character is a half-size digit: true
Otherwise: false

Description

This function checks whether or not the specified character is a half-size digit.

Reference

SFXShiftJIS::IsFullDigit

SFXShiftJIS::IsHalfKatakana

Check whether or not the specified character is a half-size Katakana.

[ public, static ]
Bool IsHalfKatakana(
    WChar param   // character to check
);

Return value

If the specified character is a half-size Katakana: true
Otherwise: false

Description

This function checks whether or not the specified character is a half-size Katakana.

Reference

SFXShiftJIS::IsFullKatakana

SFXShiftJIS::IsHalfSymbol

Check whether or not the specified character is a half-size symbol.

[ public, static ]
Bool IsHalfSymbol(
    WChar param   // character to check
);

Return value

If the specified character is a half-size symbol: true
Otherwise: false

Description

This function checks whether or not the specified character is one of the following:

!
"
#
$
%
&
(
)
*
+
,
-
.
/
:
;
<
=
>
?
@
[
]
\
^
_
`
{
|
}
~

Reference

SFXShiftJIS::IsFullSymbol | SFXShiftJIS::ToFullSymbol

SFXShiftJIS::IsPassword

Check whether or not the specified character is the special character for inputing a passwword.

[ public, static ]
Bool IsPassword(
    WChar param   // character to be checked
);

Return value

If the specified character is the special character for inputing a passwword: true
Otherwise: false

Description

This function checks whether or not the specified character is the "*"(0x2A) character for inputing a passwword.

Reference

SFXShiftJIS::ToPassword

SFXShiftJIS::KatakanaToHiragana

Convert the specified string from Katakana into Hiragana.

[ public, static ]
SFCError KatakanaToHiragana(
    SFXWideStringPtr param   // string to convert
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM

Description

This function converts the specified string from Katakana into Hiragana.

Reference

SFXShiftJIS::HiraganaToKatakana

SFXShiftJIS::ToFullAlpha

Convert the specified string from half-size alphabet into full-size alphabet.

[ public, static ]
SFCError ToFullAlpha(
    SFXWideStringPtr param   // string to convert
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM

Description

This function converts the specified string from half-size alphabet into full-size alphabet.

Reference

SFXShiftJIS::IsFullAlpha | SFXShiftJIS::ToHalfAlpha

SFXShiftJIS::ToFullDigit

Convert the specified string from half-size digit into full-size digit.

[ public, static ]
SFCError ToFullDigit(
    SFXWideStringPtr param   // string to convert
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM

Description

This function converts the specified string from half-size digit into full-size digit.

Reference

SFXShiftJIS::ToHalfDigit

SFXShiftJIS::ToFullKatakana

Convert the specified string from half-size Katakana into full-size Katakana.

[ public, static ]
SFCError ToFullKatakana(
    SFXWideStringPtr param   // string to convert
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM
If insufficient memory: SFERR_NO_MEMORY

Description

This function converts the specified string from half-size Katakana into full-size Katakana.

Reference

SFXShiftJIS::ToHalfKatakana

SFXShiftJIS::ToFullSymbol

Convert the specified string from half-size alphabet into full-size alphabet.

[ public, static ]
SFCError ToFullSymbol(
    SFXWideStringPtr param   // string to convert
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM

Description

This function converts the specified string from half-size alphabet into full-size alphabet.

Reference

SFXShiftJIS::ToHalfSymbol

SFXShiftJIS::ToHalfAlpha

Convert the specified string from full-size alphabet into half-size alphabet.

[ public, static ]
SFCError ToHalfAlpha(
    SFXWideStringPtr param   // string to convert
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM

Description

This function converts the specified string from full-size alphabet into half-size alphabet.

Reference

SFXShiftJIS::IsHalfAlpha | SFXShiftJIS::ToFullAlpha

SFXShiftJIS::ToHalfDigit

Convert the specified string from full-size digit into half-size digit.

[ public, static ]
SFCError ToHalfDigit(
    SFXWideStringPtr param   // string to convert
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM

Description

This function converts the specified string from full-size digit into half-size digit.

Reference

SFXShiftJIS::ToFullDigit

SFXShiftJIS::ToHalfKatakana

Convert the specified string from full-size Katakana into half-size Katakana.

[ public, static ]
SFCError ToHalfKatakana(
    SFXWideStringPtr param   // string to convert
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM
If insufficient memory: SFERR_NO_MEMORY

Description

This function converts the specified string from full-size Katakana into half-size Katakana.

Reference

SFXShiftJIS::ToFullKatakana

SFXShiftJIS::ToHalfSymbol

Convert the specified string from full-size symbol into half-size symbol.

[ public, static ]
SFCError ToHalfSymbol(
    SFXWideStringPtr param   // string to convert
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM

Description

This function converts the specified string from full-size symbol into half-size symbol.

Reference

SFXShiftJIS::IsHalfSymbol | SFXShiftJIS::ToFullSymbol

SFXShiftJIS::ToPassword

Convert the specified string into the password string with the special character.

[ public, static ]
SFCError ToPassword(
    SFXWideStringPtr param   // string to be converted
);

Return value

If succeeds: SFERR_NO_ERROR
the param argument is null: SFERR_INVALID_PARAM

Description

This function converts the specified string into the passwprd string with the special character. Each character is converted into the "*"(0x2A) character.

Reference

SFXShiftJIS::IsPassword