第8章 API共通リファレンス
8.4 ステータス情報
8.4.5 氏名クレンジング
注意
クレンジング関数が正常終了した場合だけ呼び出してください。正常終了でない場合の動作は不定です。
呼び出し形式
int iqjname_cleanser_getStatusCode ( const IQJNAME_CLEANSING_STATUS status, int index,
int groupID, int *code, char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
const IQJNAME_CLEANSING_STATUS status 【IN】
氏名クレンジングのステータス情報格納用インスタンスのアドレスを指定します。iqjname_cleanser_createStatus関数で取得した IQJNAME_CLEANSING_STATUSインスタンスを指定します。
NULLを指定した場合、エラーとなります。
int index 【IN】
-1を指定してください。
詳細は「8.4.1 ステータス情報の構造と取得方法」を参照してください。
int groupID 【IN】
取得するステータス情報のIDを指定します。
指定する値については「8.4.5 氏名クレンジング」を参照してください。
int *code 【OUT】
処理情報の数値を格納する領域を指定します。
取得呼び出し時のパラメーターをチェックする目的でNULLを指定することができます。NULLを指定した場合、処理情報値は取 得されません。
格納される値については「8.4.5 氏名クレンジング」を参照してください。
char *message 【OUT】
復帰値に対応したメッセージを格納する領域のアドレスを指定します。領域は呼出元が確保する必要があります。
格納されるメッセージについては「8.3.3 氏名クレンジングの復帰値／例外一覧」を参照してください。文字列はNULLターミネート されます。
メッセージは最長で1023バイトです(NULLターミネートは含みません)。
NULLを指定した場合、メッセージは取得されません。
size_t messageBufferSize 【IN】
messageパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合はメッセージは取得されません。
指定されたバイト数がメッセージを格納するのに十分な大きさでない場合、可能な限り書き込みます。メッセージは途中で切れます が、NULLターミネート文字列になることは保証されます。
void *reserve 【IN】
予約域です。NULLを指定します。NULL以外を指定した場合はエラーになります。
復帰値
正常終了した場合は0で復帰します。エラーが発生した場合は0以外で復帰します。
復帰値の詳細は「8.3.3 氏名クレンジングの復帰値／例外一覧」を参照してください。
int index, char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
IQJNAME *name 【OUT】氏名クレンジングのクレンジング結果格納用インスタンスを保持するアドレスを指定します。関数が成功するとIQJNAMEインスタン スが生成され、インスタンスのアドレスが格納されます。
NULLを指定した場合、エラーとなります。
int index 【IN】
1を指定してください。
char *message 【OUT】
復帰値に対応したメッセージを格納する領域のアドレスを指定します。領域は呼出元が確保する必要があります。
格納されるメッセージについては「8.3.3 氏名クレンジングの復帰値／例外一覧」を参照してください。文字列はNULLターミネート されます。
メッセージは最長で1023バイトです(NULLターミネートは含みません)。 NULLを指定した場合、メッセージは取得されません。
size_t messageBufferSize 【IN】
messageパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合はメッセージは取得されません。
指定されたバイト数がメッセージを格納するのに十分な大きさでない場合、可能な限り書き込みます。メッセージは途中で切れます が、NULLターミネート文字列になることは保証されます。
void *reserve 【IN】
予約域です。NULLを指定します。NULL以外を指定した場合はエラーになります。
復帰値
正常終了した場合は0で復帰します。エラーが発生した場合は0以外で復帰します。
復帰値の詳細は「8.3.3 氏名クレンジングの復帰値／例外一覧」を参照してください。
3.3.3.2 iqjname_cleanser_destroyIQJNAME
機能説明
氏名情報格納用のIQJNAMEインスタンスを破棄します。
呼び出し形式
int iqjname_cleanser_destroyIQJNAME ( IQJNAME name,
char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
IQJNAME name 【IN】氏名情報格納用インスタンスのアドレスを指定します。iqjname_cleanser_createIQJNAME関数で取得したIQJNAMEインスタンスを 指定します。
NULLを指定した場合、エラーとなります。
char *message 【OUT】
復帰値に対応したメッセージを格納する領域のアドレスを指定します。領域は呼出元が確保する必要があります。
格納されるメッセージについては「8.3.3 氏名クレンジングの復帰値／例外一覧」を参照してください。文字列はNULLターミネート されます。
メッセージは最長で1023バイトです(NULLターミネートは含みません)。 NULLを指定した場合、メッセージは取得されません。
size_t messageBufferSize 【IN】
messageパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合はメッセージは取得されません。
指定されたバイト数がメッセージを格納するのに十分な大きさでない場合、可能な限り書き込みます。メッセージは途中で切れます が、NULLターミネート文字列になることは保証されます。
void *reserve 【IN】
予約域です。NULLを指定します。NULL以外を指定した場合はエラーになります。
復帰値
正常終了した場合は0で復帰します。エラーが発生した場合は0以外で復帰します。
復帰値の詳細は「8.3.3 氏名クレンジングの復帰値／例外一覧」を参照してください。
3.3.3.3 iqjname_cleanser_getElement
機能説明
IQJNAMEインスタンスから氏名情報を文字列で取得します。
注意
・ クレンジング関数が正常終了した場合だけ呼び出してください。正常終了でない場合の動作は不定です。
・ クレンジング関数が正常終了しても、クレンジング結果が取得できない場合があります。詳細については「2.2.6 クレンジング結果 取得」の「注意」を参照してください。
呼び出し形式
int iqjname_cleanser_getElement ( const IQJNAME name,
int index, int elementKey, char *element,
size_t elementBufferSize, char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
const IQJNAME name 【IN】
氏名情報格納用インスタンスのアドレスを指定します。iqjname_cleanser_createIQJNAME関数で取得したIQJNAMEインスタンスを 指定します。
NULLを指定した場合、エラーとなります。
int index 【IN】
0を指定してください。
int elementKey 【IN】
取得する氏名情報を指定します。指定可能な値は以下のとおりです。
値 取得する情報
1 姓
2 名
char *element 【OUT】
氏名情報の文字列を格納する領域のアドレスを指定します。クレンジング時に指定したエンコーディングで格納されます。
格納される文字列は最長で800バイトです。
取得呼び出し時のパラメーターをチェックする目的でNULLを指定することができます。NULLを指定した場合、文字列は取得され ません。
size_t elementBufferSize 【IN】
elementパラメーターで与えられた領域の大きさをバイト数で指定します。
0を指定した場合は氏名情報の文字列は格納されません。
領域サイズが氏名情報の文字列を格納するのに十分な大きさでない場合、エラーになります。
char *message 【OUT】
復帰値に対応したメッセージを格納する領域のアドレスを指定します。領域は呼出元が確保する必要があります。
格納されるメッセージについては「8.3.3 氏名クレンジングの復帰値／例外一覧」を参照してください。文字列はNULLターミネート されます。
メッセージは最長で1023バイトです(NULLターミネートは含みません)。
NULLを指定した場合、メッセージは取得されません。
size_t messageBufferSize 【IN】
messageパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合はメッセージは取得されません。
指定されたバイト数がメッセージを格納するのに十分な大きさでない場合、可能な限り書き込みます。メッセージは途中で切れます が、NULLターミネート文字列になることは保証されます。
void *reserve 【IN】
予約域です。NULLを指定します。NULL以外を指定した場合はエラーになります。
復帰値
正常終了した場合は0で復帰します。エラーが発生した場合は0以外で復帰します。
復帰値の詳細は「8.3.3 氏名クレンジングの復帰値／例外一覧」を参照してください。
呼び出し形式
int iqjname_cleanser_parse ( IQJNAME_CLEANSER_HANDLE handle, ENCODING_TYPE encoding, const char *source,
const IQJNAME_CLEANSING_OPTION *option, IQJNAME name,
IQJNAME_CLEANSING_STATUS status, char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
IQJNAME_CLEANSER_HANDLE handle 【IN】
氏名クレンジングのハンドルを指定します。iqjname_cleanser_initialize関数で取得したIQJNAME_CLEANSER_HANDLEを指定 します。
ENCODING_TYPE encoding 【IN】
クレンジングする文字列のエンコーディングを指定します。
指定できる値はENCODING_TYPEを参照してください。
const char *source 【IN】
クレンジングする文字列が格納された領域のアドレスを指定します。文字列はNULLターミネートされている必要があります。
クレンジング可能な文字列は最大で200文字です。
NULLを指定した場合、エラーとなります。
const IQJNAME_CLEANSING_OPTION *option 【IN】
NULLを指定してください。
IQJNAME name 【OUT】
氏名情報格納用インスタンスを指定します。iqjname_cleanser_createIQJNAME関数で取得したIQJNAMEインスタンスを指定します。
指定されたインスタンスには氏名情報が格納されます。すでに氏名情報が格納されていた場合、新しい結果で上書きします。
NULLを指定した場合、エラーとなります。
IQJNAME_CLEANSING_STATUS status 【OUT】
氏名クレンジングのステータス情報格納用インスタンスを指定します。
iqjname_cleanser_createStatus関数で取得したIQJNAME_CLEANSING_STATUSインスタンスまたはNULLを指定します。
インスタンスを指定した場合、ステータス情報が格納されます。
NULLを指定した場合、ステータス情報は取得されません。
ステータス情報の詳細は「8.4.5 氏名クレンジング」を参照してください。
char *message 【OUT】
復帰値に対応したメッセージを格納する領域のアドレスを指定します。領域は呼出元が確保する必要があります。
格納されるメッセージについては「8.3.3 氏名クレンジングの復帰値／例外一覧」を参照してください。文字列はNULLターミネート されます。
メッセージは最長で1023バイトです(NULLターミネートは含みません)。 NULLを指定した場合、メッセージは取得されません。
size_t messageBufferSize 【IN】
messageパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合はメッセージは取得されません。
指定されたバイト数がメッセージを格納するのに十分な大きさでない場合、可能な限り書き込みます。メッセージは途中で切れます が、NULLターミネート文字列になることは保証されます。
void *reserve 【IN】
予約域です。NULLを指定します。NULL以外を指定した場合はエラーになります。