ldap_first_attributeW関数 (winldap.h)
指定されたディレクトリ エントリの場合、 ldap_first_attribute 関数は最初の属性を返します。
構文
WINLDAPAPI PWCHAR LDAPAPI ldap_first_attributeW(
[in] LDAP *ld,
[in] LDAPMessage *entry,
[out] BerElement **ptr
);
パラメーター
[in] ld
セッション ハンドル。
[in] entry
ldap_first_entryまたはldap_next_entryによって返される、ステップスルーされる属性を持つエントリ。
[out] ptr
エントリ内の現在の位置を追跡するために内部的に使用されるポインターのアドレス。
戻り値
null 終端文字列へのポインター。 関数が成功すると、現在の属性名を含む割り当てられたバッファーへのポインターが返されます。 ステップ 実行する属性がこれ以上ない場合は、 NULL を返します。 LDAP データ構造のセッション・エラー・パラメーターは、どちらの場合も 0 に設定されます。
関数が失敗すると、 NULL が 返され、LDAP データ構造のセッション エラー パラメーターが LDAP エラー コードに設定されます。
注釈
ldap_first_attributeをldap_next_attribute と組み合わせて使用して、エントリで返される属性型の一覧をステップ実行します。 その後、これらの属性名を ldap_get_values の呼び出しで渡して、関連する値を取得できます。
ldap_first_attribute の呼び出しは、BerElement 構造体へのポインターである ptr パラメーターを使用してを割り当て、返します。 このポインターを ldap_next_attribute に渡して、属性の一覧内の現在の位置を追跡します。 属性の一覧のステップ実行が完了し、 ptr が NULL 以外の場合は、 ber_free( ptr, 0 ) を呼び出してポインターを解放します。 この呼び出しでは、2 番目のパラメーターを 0 (ゼロ) として渡す必要があることに注意してください。
ldap_first_attributeとldap_next_attributeの両方が、現在の属性名を含む割り当てられたバッファーへのポインターを返します。 不要になった場合は、ldap_memfreeを呼び出して、このバッファー を解放します。 このバッファーは、 ldap_first_attribute または への 次の呼び出しで上書きされるため
ldap_next_attribute、処理のために属性名を保持する必要がある場合は、属性名のコピーを作成する必要があります。
注意
winldap.h ヘッダーは、ldap_first_attributeをエイリアスとして定義します。これは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista |
サポートされている最小のサーバー | Windows Server 2008 |
対象プラットフォーム | Windows |
ヘッダー | winldap.h |
Library | Wldap32.lib |
[DLL] | Wldap32.dll |