第3章 C APIリファレンス
3.3 氏名クレンジング
3.3.2 ステータス情報操作
3.3.2.1 iqjname_cleanser_createStatus
機能説明
氏名クレンジングのステータス情報格納用のIQJNAME_CLEANSING_STATUSインスタンスを生成して返却します。
iqjname_cleanser_destroyStatus関数とセットで呼び出してください。
呼び出し形式
int iqjname_cleanser_createStatus ( IQJNAME_CLEANSING_STATUS *status, int index,
char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
IQJNAME_CLEANSING_STATUS *status 【OUT】
氏 名 ク レ ン ジ ン グ の ス テ ー タ ス 情 報 格 納 用 イ ン ス タ ン ス を 保 持 す る ア ド レ ス を 指 定 し ま す 。 関 数 が 成 功 す る と IQJNAME_CLEANSING_STATUSインスタンスが生成され、インスタンスのアドレスが格納されます。
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.2.2 iqjname_cleanser_destroyStatus
機能説明
氏名クレンジングのステータス情報格納用のIQJNAME_CLEANSING_STATUSインスタンスを破棄します。
呼び出し形式
int iqjname_cleanser_destroyStatus ( IQJNAME_CLEANSING_STATUS status, char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
IQJNAME_CLEANSING_STATUS status 【IN】
氏名クレンジングのステータス情報格納用インスタンスのアドレスを指定します。iqjname_cleanser_createStatus関数で取得した IQJNAME_CLEANSING_STATUSインスタンスを指定します。
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.2.3 iqjname_cleanser_getStatusCode
機能説明
氏名クレンジングのステータス情報格納用のIQJNAME_CLEANSING_STATUSインスタンスからコードを取得します。
取得されるコードは、「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 氏名クレンジングの復帰値／例外一覧」を参照してください。