ldap_parse_result 関数 (winldap.h)
ldap_parse_result関数は、サーバーからの応答を解析し、適切なフィールドを返します。
構文
WINLDAPAPI ULONG LDAPAPI ldap_parse_result(
[in] LDAP *Connection,
[in] LDAPMessage *ResultMessage,
[out, optional] ULONG *ReturnCode,
[out, optional] PSTR *MatchedDNs,
[out, optional] PSTR *ErrorMessage,
[out, optional] PSTR **Referrals,
[out, optional] PLDAPControlA **ServerControls,
[in] BOOLEAN Freeit
);
パラメーター
[in] Connection
セッション ハンドル。
[in] ResultMessage
同期操作の呼び出しの 1 つまたは非同期操作の ldap_result によって返される LDAP 操作の結果。
[out, optional] ReturnCode
元の結果メッセージを生成したサーバー操作の結果を示します。 このフィールドを無視するには NULL を 渡します。
[out, optional] MatchedDNs
null で終わるワイド文字列へのポインター。 LDAP_NO_SUCH_OBJECTが返された場合、この結果パラメーターには、要求で認識された名前の量を示す識別名が入力されます。 このフィールドを無視するには NULL を 渡します。
[out, optional] ErrorMessage
ResultMessage パラメーターのエラー メッセージ フィールドの内容を含む、null で終わるワイド文字列へのポインター。 このフィールドを無視するには NULL を 渡します。
[out, optional] Referrals
ResultMessage パラメーターの紹介フィールドの内容を含む、null で終わるワイド文字列へのポインター。要求を再試行する代替 LDAP サーバーが 0 個以上であることを示します。 このフィールドを無視するには NULL を 渡します。
[out, optional] ServerControls
この結果パラメーターには、 ResultMessage パラメーターからコピーされたコントロールの割り当てられた配列が入力されます。
[in] Freeit
ResultMessage パラメーターを解放するかどうかを決定します。 Freeit パラメーターに 0 以外の値を渡すと、ResultMessage ポインターが不要になったときに解放するか、ldap_msgfreeを呼び出して後で結果を解放できます。
戻り値
関数が成功した場合、戻り値は LDAP_SUCCESS。
関数が失敗した場合はエラー コードを返します。 詳細については、「 戻り値 」を参照してください。
解説
ldap_parse_result関数は、解析する結果メッセージを検索するサーバー応答のチェーンを走査します。 紹介、識別名の一致、または返されたサーバー コントロールにアクセスする場合は、この関数を使用します。 関数は、LDAP_RES_SEARCH_ENTRY型とLDAP_RES_SEARCH_REFERENCE型のメッセージをスキップします。
必要がなくなったら、ldap_memfreeを呼び出して ErrorMessage 文字列と MatchedDNs 文字列を解放します。 ldap_value_freeを呼び出して 、Referrals 配列 を解放します。 ldap_controls_freeを呼び出して ServerControls を解放します。
要件
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |