第8章 API共通リファレンス
8.4 ステータス情報
8.4.6 法人名クレンジング
注意
クレンジング関数が正常終了した場合だけ呼び出してください。正常終了でない場合の動作は不定です。
呼び出し形式
int iqjcorp_cleanser_getStatusCode ( const IQJCORP_CLEANSING_STATUS status, int index,
int groupID, int *code, char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
const IQJCORP_CLEANSING_STATUS status 【IN】
法 人 名 ク レ ン ジ ン グ の ス テ ー タ ス 情 報 格 納 用 イ ン ス タ ン ス を 指 定 し ま す 。iqjcorp_cleanser_createStatus関 数 で 取 得 し た
IQJCORP_CLEANSING_STATUSインスタンスを指定します。
NULLを指定した場合、エラーとなります。
int index 【IN】
-1を指定してください。
詳細は「8.4.1 ステータス情報の構造と取得方法」を参照してください。
int groupID 【IN】
取得するステータス情報のIDを指定します。
指定する値については「8.4.6 法人名クレンジング」を参照してください。
int *code 【OUT】
処理情報の数値を格納する領域を指定します。
取得呼び出し時のパラメーターをチェックする目的でNULLを指定することができます。NULLを指定した場合、処理情報値は取 得されません。
格納される値については「8.4.6 法人名クレンジング」を参照してください。
char *message 【OUT】
復帰値に対応したメッセージを格納する領域のアドレスを指定します。領域は呼出元が確保する必要があります。
格納されるメッセージについては「8.3.4 法人名クレンジングの復帰値／例外一覧」を参照してください。文字列はNULLターミネー トされます。
メッセージは最長で1023バイトです(NULLターミネートは含みません)。
NULLを指定した場合、メッセージは取得されません。
size_t messageBufferSize 【IN】
messageパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合はメッセージは取得されません。
指定されたバイト数がメッセージを格納するのに十分な大きさでない場合、可能な限り書き込みます。メッセージは途中で切れます が、NULLターミネート文字列になることは保証されます。
void *reserve 【IN】
予約域です。NULLを指定します。NULL以外を指定した場合はエラーになります。
復帰値
正常終了した場合は0で復帰します。エラーが発生した場合は0以外で復帰します。
復帰値の詳細は「8.3.4 法人名クレンジングの復帰値／例外一覧」を参照してください。
int index 【IN】
1を指定してください。
char *message 【OUT】
復帰値に対応したメッセージを格納する領域のアドレスを指定します。領域は呼出元が確保する必要があります。
格納されるメッセージについては「8.3.4 法人名クレンジングの復帰値／例外一覧」を参照してください。文字列はNULLターミネー トされます。
メッセージは最長で1023バイトです(NULLターミネートは含みません)。
NULLを指定した場合、メッセージは取得されません。
size_t messageBufferSize 【IN】
messageパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合はメッセージは取得されません。
指定されたバイト数がメッセージを格納するのに十分な大きさでない場合、可能な限り書き込みます。メッセージは途中で切れます が、NULLターミネート文字列になることは保証されます。
void *reserve 【IN】
予約域です。NULLを指定します。NULL以外を指定した場合はエラーになります。
復帰値
正常終了した場合は0で復帰します。エラーが発生した場合は0以外で復帰します。
復帰値の詳細は「8.3.4 法人名クレンジングの復帰値／例外一覧」を参照してください。
3.4.3.2 iqjcorp_cleanser_destroyIQJCORP
機能説明
法人名情報格納用のIQJCORPインスタンスを破棄します。
呼び出し形式
int iqjcorp_cleanser_destroyIQJCORP ( IQJCORP corp,
char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
IQJCORP corp 【IN】法人名情報格納用インスタンスのアドレスを指定します。iqjcorp_cleanser_createIQJCORP関数で取得したIQJCORPインスタンスを 指定します。
NULLを指定した場合、エラーとなります。
char *message 【OUT】
復帰値に対応したメッセージを格納する領域のアドレスを指定します。領域は呼出元が確保する必要があります。
格納されるメッセージについては「8.3.4 法人名クレンジングの復帰値／例外一覧」を参照してください。文字列はNULLターミネー トされます。
メッセージは最長で1023バイトです(NULLターミネートは含みません)。 NULLを指定した場合、メッセージは取得されません。
size_t messageBufferSize 【IN】
messageパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合はメッセージは取得されません。
指定されたバイト数がメッセージを格納するのに十分な大きさでない場合、可能な限り書き込みます。メッセージは途中で切れます が、NULLターミネート文字列になることは保証されます。
void *reserve 【IN】
予約域です。NULLを指定します。NULL以外を指定した場合はエラーになります。
復帰値
正常終了した場合は0で復帰します。エラーが発生した場合は0以外で復帰します。
復帰値の詳細は「8.3.4 法人名クレンジングの復帰値／例外一覧」を参照してください。
3.4.3.3 iqjcorp_cleanser_getElement
機能説明
IQJCORPインスタンスから法人名情報を文字列で取得します。
注意
・ クレンジング関数が正常終了した場合だけ呼び出してください。正常終了でない場合の動作は不定です。
・ クレンジング関数が正常終了しても、クレンジング結果が取得できない場合があります。詳細については「2.2.6 クレンジング結果 取得」の「注意」を参照してください。
呼び出し形式
int iqjcorp_cleanser_getElement ( const IQJCORP corp,
int index, int elementKey, char *element,
size_t elementBufferSize, char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
const IQJCORP corp 【IN】法人名情報格納用インスタンスのアドレスを指定します。iqjcorp_cleanser_createIQJCORP関数で取得したIQJCORPインスタンスを 指定します。
NULLを指定した場合、エラーとなります。
int index 【IN】
0を指定してください。
int elementKey 【IN】
取得する法人名情報を指定します。指定可能な値は以下のとおりです。
指定可能な値 取得する情報
1 法人名称
2 法人種別
3 法人種別(正式表記)
指定可能な値 取得する情報
4 その他
char *element 【OUT】
法人名情報の文字列を格納する領域のアドレスを指定します。クレンジング時に指定したエンコーディングで情報格納されます。
格納される文字列は最長で1600バイトです。
取得呼び出し時のパラメーターをチェックする目的でNULLを指定することができます。NULLを指定した場合、法人名情報の文字 列は取得されません。
size_t elementBufferSize 【IN】
elementパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合は法人名情報の文字列は格納されません。
領域サイズが法人名情報の文字列を格納するのに十分な大きさでない場合、エラーになります。
char *message 【OUT】
復帰値に対応したメッセージを格納する領域のアドレスを指定します。領域は呼出元が確保する必要があります。
格納されるメッセージについては「8.3.4 法人名クレンジングの復帰値／例外一覧」を参照してください。文字列はNULLターミネー トされます。
メッセージは最長で1023バイトです(NULLターミネートは含みません)。 NULLを指定した場合、メッセージは取得されません。
size_t messageBufferSize 【IN】
messageパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合はメッセージは取得されません。
指定されたバイト数がメッセージを格納するのに十分な大きさでない場合、可能な限り書き込みます。メッセージは途中で切れます が、NULLターミネート文字列になることは保証されます。
void *reserve 【IN】
予約域です。NULLを指定します。NULL以外を指定した場合はエラーになります。
復帰値
正常終了した場合は0で復帰します。エラーが発生した場合は0以外で復帰します。
復帰値の詳細は「8.3.4 法人名クレンジングの復帰値／例外一覧」を参照してください。
3.4.3.4 iqjcorp_cleanser_getElementValue
機能説明
IQJCORPインスタンスから法人名情報を数値で取得します。
注意
・ クレンジング関数が正常終了した場合だけ呼び出してください。正常終了でない場合の動作は不定です。
・ クレンジング関数が正常終了しても、クレンジング結果が取得できない場合があります。詳細については「2.2.6 クレンジング結果 取得」の「注意」を参照してください。
呼び出し形式
int iqjcorp_cleanser_getElementValue ( const IQJCORP corp,
int index, int elementKey, int *elementValue,
char *message,
size_t messageBufferSize, void *reserve
);
パラメーターの説明
const IQJCORP corp 【IN】法人名情報格納用インスタンスのアドレスを指定します。iqjcorp_cleanser_createIQJCORP関数で取得したIQJCORPインスタンスを 指定します。
NULLを指定した場合、エラーとなります。
int index 【IN】
0を指定してください。
int elementKey 【IN】
取得する法人名情報を指定します。指定可能な値は以下のとおりです。
指定可能な値 取得する情報
1 法人種別の位置情報 int *elementValue 【OUT】
法人名情報の数値を格納する領域のアドレスを指定します。
以下のいずれかが格納されます。
elementKey 情報数値 意味
1 0 法人種別の表記がなかった
1 法人名称の前 2 法人名称の後ろ
取得呼び出し時のパラメーターをチェックする目的でNULLを指定することができます。NULLを指定した場合、法人名情報の数値 は取得されません。
char *message 【OUT】
復帰値に対応したメッセージを格納する領域のアドレスを指定します。領域は呼出元が確保する必要があります。
格納されるメッセージについては「8.3.4 法人名クレンジングの復帰値／例外一覧」を参照してください。文字列はNULLターミネー トされます。
メッセージは最長で1023バイトです(NULLターミネートは含みません)。
NULLを指定した場合、メッセージは取得されません。
size_t messageBufferSize 【IN】
messageパラメーターで与えられる領域の大きさをバイト数で指定します。
0を指定した場合はメッセージは取得されません。
指定されたバイト数がメッセージを格納するのに十分な大きさでない場合、可能な限り書き込みます。メッセージは途中で切れます が、NULLターミネート文字列になることは保証されます。
void *reserve 【IN】
予約域です。NULLを指定します。NULL以外を指定した場合はエラーになります。
復帰値
正常終了した場合は0で復帰します。エラーが発生した場合は0以外で復帰します。
復帰値の詳細は「8.3.4 法人名クレンジングの復帰値／例外一覧」を参照してください。