Win32 API 日本語リファレンス
ホームNetworking.Ldap › ldap_initW

ldap_initW

関数
LDAPセッションを初期化する(Unicode版)。
DLLWLDAP32.dll文字セットUnicode (-W)呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

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

LDAP* ldap_initW(
    LPCWSTR HostName,
    DWORD PortNumber
);

パラメーター

名前方向説明
HostNameLPCWSTRinドメイン名、または接続先の LDAP サーバーを実行しているホストのホスト名を空白で区切った一覧、あるいはそれらのホストの IP アドレスを表すドット表記の文字列を含む、null で終わる文字列へのポインター。一覧内の各ホスト名には、ホスト名自体とコロン (:) で区切って、省略可能なポート番号を含めることができます。Active Directory サーバーへ接続する際の LDAP_OPT_AREC_EXCLUSIVE オプションの使用について詳しくは、「解説」セクションを参照してください。
PortNumberDWORDin接続先の TCP ポート番号を指定します。既定のポートである 389 を使用するには LDAP_PORT を設定します。ホスト名にポート番号が含まれている場合、このパラメーターは無視されます。

戻り値の型: LDAP*

公式ドキュメント

ldap_initW (Unicode) 関数 (winldap.h) は、LDAP サーバーとのセッションを初期化します。

戻り値

関数が成功した場合は、LDAP データ構造体へのポインターの形式でセッションハンドルを返します。セッションハンドルは、不要になった時点で ldap_unbind を呼び出して解放する必要があります。

関数が失敗した場合は NULL を返します。エラーコードを取得するには LdapGetLastError を使用します。

解説(Remarks)

LDAP サーバーへの接続ブロックを作成するには、ldap_init を呼び出します。ldap_open とは異なり、ldap_init の呼び出しでは接続は開かれません。ライブラリにサーバーへ接続させるには、ldap_connect を明示的に呼び出すことができます。これは、ローカルのタイムアウトを指定したい場合に役立ちます。その場合は、ldap_connect を呼び出す前に、ldap_init で得られた接続ブロックを指定して ldap_set_option を呼び出します。ただし通常は、開いた接続を必要とする最初の操作関数が、まだ呼び出されていなければ内部で ldap_connect を呼び出すため、この呼び出しは不要です。

この関数は、セッションの状態データを保持するための LDAP データ構造体を割り当て、その構造体へのハンドルを返します。セッション中の LDAP 関数の呼び出しには、このハンドルを渡します。

HostName パラメーターには NULL を指定できます。その場合、ランタイムは「既定の」LDAP サーバーを検索しようとします。ldap_connect が呼び出されると、ホストは列挙された順に試行され、最初に接続に成功した時点で停止します。Active Directory サーバーの場合は、DsGetDcName 関数を使用してサーバー名を取得し、NULL を使用する代わりに、それを HostName パラメーターとして渡すことができます。

ldap_set_option 関数を使用して LDAP_OPT_GETDSNAME_FLAGS オプションを設定した場合も同様です。このオプションは、接続先の DC を検出するために DsGetDCName に渡されるフラグを指定します。LDAP クライアントは、LDAP_OPT_GETDSNAME_FLAGS が指定するフラグに加えて、DS_ONLY_LDAP_NEEDED フラグも DsGetDCName に渡します。

HostName パラメーターに NULL を渡し、かつ呼び出し元のコンピューターが Active Directory ドメインのメンバーである場合、ランタイムは接続を試みる際に、現在のコンピューターがメンバーとなっているドメイン内の DC を検索します。

HostName パラメーターに NULL を渡し、かつ呼び出し元のコンピューターが Active Directory ドメインの DC である場合、ランタイムは接続を試みる際に NULL を 127.0.0.1 に置き換え、ループバックを使用してローカルコンピューターに接続します。

HostName パラメーターに Active Directory のドメイン名を渡した場合、ldap_init はそのドメイン内の「既定の」LDAP サーバーを検索します。

HostNameNULL またはドメイン名のいずれかを設定した場合は、自動再接続が適用されます。接続の有効期間中に、接続先の DC が何らかの理由で機能しなくなった場合、LDAP は指定されたドメイン内の別の DC へ自動的に再接続します。この動作は LDAP_OPT_AUTO_RECONNECT セッションオプションでオフまたはオンに切り替えることができ、既定ではオンです。

HostName パラメーターに Active Directory の DNS サーバー名を渡す場合は、実際の接続を作成する LDAP 関数を呼び出す前に、ldap_set_option を呼び出して LDAP_OPT_AREC_EXCLUSIVE フラグをオンに設定する必要があります。これにより、ホスト名の解決時に A レコードの参照が強制され、SRV レコードの参照は回避されます。ダイヤルアップ接続を使用する支社などの場合、A レコード参照を使用すると、名前解決の際に SRV レコードを求めてリモート DNS サーバーへ問い合わせるためにダイヤルアップが強制されるのを避けられます。

グローバルカタログのポート番号を引数の 1 つとして ldap_init に渡す場合、そのポート番号に対して渡す HostName は、内部で呼び出される DsGetDcName() がエンタープライズ内の GC を正しく検出できるように、フォレストの名前である必要があります。

マルチスレッド: ldap_init の呼び出しはスレッドセーフです。

ldap_init は、LDAP セッションを初期化する方法として推奨されます。ldap_open の使用は、セッションオプションを設定できなくなるため、現行の LDAP RFC で強く非推奨とされています。
メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

LDAP* ldap_initW(
    LPCWSTR HostName,
    DWORD PortNumber
);
[DllImport("WLDAP32.dll", CharSet = CharSet.Unicode, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern IntPtr ldap_initW(
    [MarshalAs(UnmanagedType.LPWStr)] string HostName,   // LPCWSTR
    uint PortNumber   // DWORD
);
<DllImport("WLDAP32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_initW(
    <MarshalAs(UnmanagedType.LPWStr)> HostName As String,   ' LPCWSTR
    PortNumber As UInteger   ' DWORD
) As IntPtr
End Function
' HostName : LPCWSTR
' PortNumber : DWORD
Declare PtrSafe Function ldap_initW Lib "wldap32" ( _
    ByVal HostName As LongPtr, _
    ByVal PortNumber As Long) As LongPtr
' 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_initW = ctypes.cdll.wldap32.ldap_initW
ldap_initW.restype = ctypes.c_void_p
ldap_initW.argtypes = [
    wintypes.LPCWSTR,  # HostName : LPCWSTR
    wintypes.DWORD,  # PortNumber : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_initW = Fiddle::Function.new(
  lib['ldap_initW'],
  [
    Fiddle::TYPE_VOIDP,  # HostName : LPCWSTR
    -Fiddle::TYPE_INT,  # PortNumber : DWORD
  ],
  Fiddle::TYPE_VOIDP, Fiddle::Function::CDECL)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wldap32")]
extern "C" {
    fn ldap_initW(
        HostName: *const u16,  // LPCWSTR
        PortNumber: u32  // DWORD
    ) -> *mut LDAP;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WLDAP32.dll", CharSet = CharSet.Unicode, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr ldap_initW([MarshalAs(UnmanagedType.LPWStr)] string HostName, uint PortNumber);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_initW' -Namespace Win32 -PassThru
# $api::ldap_initW(HostName, PortNumber)
#uselib "WLDAP32.dll"
#func global ldap_initW "ldap_initW" wptr, wptr
; ldap_initW HostName, PortNumber   ; 戻り値は stat
; HostName : LPCWSTR -> "wptr"
; PortNumber : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WLDAP32.dll"
#cfunc global ldap_initW "ldap_initW" wstr, int
; res = ldap_initW(HostName, PortNumber)
; HostName : LPCWSTR -> "wstr"
; PortNumber : DWORD -> "int"
; LDAP* ldap_initW(LPCWSTR HostName, DWORD PortNumber)
#uselib "WLDAP32.dll"
#cfunc global ldap_initW "ldap_initW" wstr, int
; res = ldap_initW(HostName, PortNumber)
; HostName : LPCWSTR -> "wstr"
; PortNumber : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wldap32 = windows.NewLazySystemDLL("WLDAP32.dll")
	procldap_initW = wldap32.NewProc("ldap_initW")
)

// HostName (LPCWSTR), PortNumber (DWORD)
r1, _, err := procldap_initW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(HostName))),
	uintptr(PortNumber),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LDAP*
function ldap_initW(
  HostName: PWideChar;   // LPCWSTR
  PortNumber: DWORD   // DWORD
): Pointer; cdecl;
  external 'WLDAP32.dll' name 'ldap_initW';
result := DllCall("WLDAP32\ldap_initW"
    , "WStr", HostName   ; LPCWSTR
    , "UInt", PortNumber   ; DWORD
    , "Cdecl Ptr")   ; return: LDAP*
●ldap_initW(HostName, PortNumber) = DLL("WLDAP32.dll", "void* ldap_initW(char*, dword)")
# 呼び出し: ldap_initW(HostName, PortNumber)
# HostName : LPCWSTR -> "char*"
# PortNumber : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。
const std = @import("std");

extern "wldap32" fn ldap_initW(
    HostName: [*c]const u16, // LPCWSTR
    PortNumber: u32 // DWORD
) callconv(.c) [*c]LDAP;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ldap_initW(
    HostName: WideCString,  # LPCWSTR
    PortNumber: uint32  # DWORD
): ptr LDAP {.importc: "ldap_initW", cdecl, dynlib: "WLDAP32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wldap32");
extern(C)
LDAP* ldap_initW(
    const(wchar)* HostName,   // LPCWSTR
    uint PortNumber   // DWORD
);
ccall((:ldap_initW, "WLDAP32.dll"), Ptr{LDAP},
      (Cwstring, UInt32),
      HostName, PortNumber)
# HostName : LPCWSTR -> Cwstring
# PortNumber : DWORD -> UInt32
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* ldap_initW(
    const uint16_t* HostName,
    uint32_t PortNumber);
]]
local wldap32 = ffi.load("wldap32")
-- wldap32.ldap_initW(HostName, PortNumber)
-- HostName : LPCWSTR
-- PortNumber : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WLDAP32.dll');
const ldap_initW = lib.func('__cdecl', 'ldap_initW', 'void *', ['str16', 'uint32_t']);
// ldap_initW(HostName, PortNumber)
// HostName : LPCWSTR -> 'str16'
// PortNumber : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WLDAP32.dll", {
  ldap_initW: { parameters: ["buffer", "u32"], result: "pointer" },
});
// lib.symbols.ldap_initW(HostName, PortNumber)
// HostName : LPCWSTR -> "buffer"
// PortNumber : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* ldap_initW(
    const uint16_t* HostName,
    uint32_t PortNumber);
C, "WLDAP32.dll");
// $ffi->ldap_initW(HostName, PortNumber);
// HostName : LPCWSTR
// PortNumber : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wldap32 extends Library {
    Wldap32 INSTANCE = Native.load("wldap32", Wldap32.class, W32APIOptions.UNICODE_OPTIONS);
    Pointer ldap_initW(
        WString HostName,   // LPCWSTR
        int PortNumber   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wldap32")]
lib LibWLDAP32
  fun ldap_initW = ldap_initW(
    HostName : UInt16*,   # LPCWSTR
    PortNumber : UInt32   # DWORD
  ) : LDAP*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ldap_initWNative = Pointer<Void> Function(Pointer<Utf16>, Uint32);
typedef ldap_initWDart = Pointer<Void> Function(Pointer<Utf16>, int);
final ldap_initW = DynamicLibrary.open('WLDAP32.dll')
    .lookupFunction<ldap_initWNative, ldap_initWDart>('ldap_initW');
// HostName : LPCWSTR -> Pointer<Utf16>
// PortNumber : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ldap_initW(
  HostName: PWideChar;   // LPCWSTR
  PortNumber: DWORD   // DWORD
): Pointer; cdecl;
  external 'WLDAP32.dll' name 'ldap_initW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "ldap_initW"
  c_ldap_initW :: CWString -> Word32 -> IO (Ptr ())
-- HostName : LPCWSTR -> CWString
-- PortNumber : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ldap_initw =
  foreign "ldap_initW"
    ((ptr uint16_t) @-> uint32_t @-> returning (ptr void))
(* HostName : LPCWSTR -> (ptr uint16_t) *)
(* PortNumber : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wldap32 (t "WLDAP32.dll"))
(cffi:use-foreign-library wldap32)

(cffi:defcfun ("ldap_initW" ldap-init-w :convention :cdecl) :pointer
  (host-name (:string :encoding :utf-16le))   ; LPCWSTR
  (port-number :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ldap_initW = Win32::API::More->new('WLDAP32',
    'LPVOID ldap_initW(LPCWSTR HostName, DWORD PortNumber)');
# my $ret = $ldap_initW->Call($HostName, $PortNumber);
# HostName : LPCWSTR -> LPCWSTR
# PortNumber : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型