ldap_bindW

関数

指定方式でLDAPサーバーに非同期バインドする(Unicode版)。

DLLWLDAP32.dll文字セットUnicode (-W)呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

// WLDAP32.dll  (Unicode / -W)
#include <windows.h>

DWORD ldap_bindW(
    LDAP* ld,
    LPWSTR dn,   // optional
    LPWSTR cred,   // optional
    DWORD method
);

パラメーター

名前	型	方向	説明
ld	LDAP*	inout	セッションハンドル。
dn	LPWSTR	inoptional	バインドに使用するエントリの識別名を含む、null 終端文字列へのポインター。
cred	LPWSTR	inoptional	認証に使用する資格情報を含む、null 終端文字列へのポインター。このパラメーターを使用して、任意の資格情報を渡すことができます。資格情報の形式と内容は、method パラメーターの設定によって異なります。詳細については、「解説」セクションを参照してください。
method	DWORD	in	使用する認証方法。

戻り値の型: DWORD

公式ドキュメント

ldap_bindW (Unicode) 関数 (winldap.h) は、LDAP サーバーに対してクライアントを非同期に認証します。

戻り値

関数が成功した場合、戻り値は開始された操作のメッセージ ID です。

関数が失敗した場合は –1 を返し、LDAP 構造体にセッションのエラーパラメーターを設定します。

解説(Remarks)

この ldap_bind の実装は、次の認証方法をサポートします。

認証方法	説明	資格情報
LDAP_AUTH_SIMPLE	平文パスワードによる認証。	ユーザーのパスワードを含む文字列。

LDAP_AUTH_SIMPLE は、非同期版のバインドである ldap_bind と互換性のある唯一の認証方法です。ldap_bind でこれ以外の認証方法を使用すると失敗し、LDAP_PARAM_ERROR が返されます。LDAP_AUTH_SIMPLE 方法で ldap_bind を呼び出すことは、ldap_simple_bind を呼び出すことと同等です。その他のすべての認証方法では、ldap_bind_s が提供する同期バインドが必要です。

LDAP 2 サーバーでは、認証を必要とする他の操作を試みる前に、アプリケーションがバインドを行う必要があることに注意してください。

マルチスレッド: バインド呼び出しは接続全体に適用されるため、安全ではありません。スレッド間で接続を共有する場合は注意し、可能であればバインド操作を他の操作とスレッド化してください。

注意 Microsoft LDAP クライアントは、バインドと応答の各ラウンドトリップに対して既定のタイムアウト値として 120 秒を使用します。このタイムアウト値は、LDAP_OPT_TIMELIMIT セッションオプションを使用して変更できます。他の操作には、 ldap_set_option を使用して指定しない限り、タイムアウトはありません。

セッションハンドルに対するすべての操作が完了したら、LDAP セッションハンドルを ldap_unbind 関数に渡してセッションを終了してください。また、ldap_bind の呼び出しが失敗した場合も、エラー回復のために不要になった時点で ldap_unbind を呼び出してセッションハンドルを解放する必要があります。

メモ

winldap.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ldap_bind を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WLDAP32.dll  (Unicode / -W)
#include <windows.h>

DWORD ldap_bindW(
    LDAP* ld,
    LPWSTR dn,   // optional
    LPWSTR cred,   // optional
    DWORD method
);

[DllImport("WLDAP32.dll", CharSet = CharSet.Unicode, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern uint ldap_bindW(
    IntPtr ld,   // LDAP* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string dn,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string cred,   // LPWSTR optional
    uint method   // DWORD
);

<DllImport("WLDAP32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_bindW(
    ld As IntPtr,   ' LDAP* in/out
    <MarshalAs(UnmanagedType.LPWStr)> dn As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> cred As String,   ' LPWSTR optional
    method As UInteger   ' DWORD
) As UInteger
End Function

' ld : LDAP* in/out
' dn : LPWSTR optional
' cred : LPWSTR optional
' method : DWORD
Declare PtrSafe Function ldap_bindW Lib "wldap32" ( _
    ByVal ld As LongPtr, _
    ByVal dn As LongPtr, _
    ByVal cred As LongPtr, _
    ByVal method As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ldap_bindW = ctypes.cdll.wldap32.ldap_bindW
ldap_bindW.restype = wintypes.DWORD
ldap_bindW.argtypes = [
    ctypes.c_void_p,  # ld : LDAP* in/out
    wintypes.LPCWSTR,  # dn : LPWSTR optional
    wintypes.LPCWSTR,  # cred : LPWSTR optional
    wintypes.DWORD,  # method : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_bindW = Fiddle::Function.new(
  lib['ldap_bindW'],
  [
    Fiddle::TYPE_VOIDP,  # ld : LDAP* in/out
    Fiddle::TYPE_VOIDP,  # dn : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # cred : LPWSTR optional
    -Fiddle::TYPE_INT,  # method : DWORD
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wldap32")]
extern "C" {
    fn ldap_bindW(
        ld: *mut LDAP,  // LDAP* in/out
        dn: *mut u16,  // LPWSTR optional
        cred: *mut u16,  // LPWSTR optional
        method: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WLDAP32.dll", CharSet = CharSet.Unicode, CallingConvention = CallingConvention.Cdecl)]
public static extern uint ldap_bindW(IntPtr ld, [MarshalAs(UnmanagedType.LPWStr)] string dn, [MarshalAs(UnmanagedType.LPWStr)] string cred, uint method);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_bindW' -Namespace Win32 -PassThru
# $api::ldap_bindW(ld, dn, cred, method)

#uselib "WLDAP32.dll"
#func global ldap_bindW "ldap_bindW" wptr, wptr, wptr, wptr
; ldap_bindW varptr(ld), dn, cred, method   ; 戻り値は stat
; ld : LDAP* in/out -> "wptr"
; dn : LPWSTR optional -> "wptr"
; cred : LPWSTR optional -> "wptr"
; method : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WLDAP32.dll"
#cfunc global ldap_bindW "ldap_bindW" var, wstr, wstr, int
; res = ldap_bindW(ld, dn, cred, method)
; ld : LDAP* in/out -> "var"
; dn : LPWSTR optional -> "wstr"
; cred : LPWSTR optional -> "wstr"
; method : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WLDAP32.dll"
#cfunc global ldap_bindW "ldap_bindW" sptr, wstr, wstr, int
; res = ldap_bindW(varptr(ld), dn, cred, method)
; ld : LDAP* in/out -> "sptr"
; dn : LPWSTR optional -> "wstr"
; cred : LPWSTR optional -> "wstr"
; method : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。