ldap_sslinitW関数 (winldap.h)
ldap_sslinit関数は、LDAP サーバーとの Secure Sockets Layer (SSL) セッションを初期化します。
構文
WINLDAPAPI LDAP *LDAPAPI ldap_sslinitW(
[in] PWSTR HostName,
[in] ULONG PortNumber,
[in] int secure
);
パラメーター
[in] HostName
接続先の LDAP サーバーを実行しているホストの IP アドレスを表すホスト名または点線の文字列のスペース区切りのリストを含む null で終わる文字列へのポインター。 リスト内の各ホスト名には、ホスト自体からコロン (:) 文字で区切られた省略可能なポート番号を含めることができます。
[in] PortNumber
接続先の TCP ポート番号が含まれます。 既定のポート 636 を取得するには、 LDAP_SSL_PORT に設定します。 ホスト名にポート番号が含まれている場合、このパラメーターは無視されます。
[in] secure
0 以外の場合、関数は SSL 暗号化を使用します。 値が 0 の場合、関数はプレーン TCP 接続を確立し、クリア テキスト (暗号化なし) を使用します。
戻り値
関数が成功すると、 LDAP 構造体へのポインターの形式でセッション ハンドルが返されます。 セッション ハンドルは、不要になったときに ldap_unbind の呼び出しで解放する必要があります。
関数が失敗した場合は、返される値は NULL です。 LdapGetLastError を使用してエラー コードを取得します。
注釈
ldap_sslinitを呼び出して、セキュリティで保護された LDAP サーバーへの接続ブロックを作成します。 HostName パラメーターには NULL を指定できます。この場合、実行時に "default" LDAP サーバーの検索が試行されます。 ホストは一覧表示されている順序で試行され、正常に接続された最初のホストで停止します。
HostName が NULL またはドメイン名に設定されている場合は、自動再接続が適用されます。 接続されている DC が接続の有効期間中に何らかの理由で機能しなくなった場合、LDAP は指定されたドメイン内の別の DC に自動的に再接続します。 この動作は、既定でオンになっている LDAP_OPT_AUTO_RECONNECT セッション オプションを使用して、オフまたはオンに切り替えることができます。
グローバル カタログのポート番号が引数の 1 つとして ldap_sslinit に渡される場合、そのポート番号に渡される HostName は、 基になる DsGetDcName の呼び出しでエンタープライズ内の GC を正しく検索するためのフォレストの名前である必要があります。
関数は、セッションの状態情報を維持するために LDAP 構造体を割り当て、この構造体へのハンドルを返します。 このハンドルは、セッション中に後続の LDAP 関数呼び出しに渡します。
マルチスレッド: ldap_sslinit の呼び出しはスレッド セーフです。
Microsoft では、SSPI 機能を使用して SSL などのセキュリティ機能を実装しています。
注意
winldap.h ヘッダーは、ldap_sslinitをエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |