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

ldap_openW

関数
LDAPサーバーへの接続を開く(Unicode版)。
DLLWLDAP32.dll文字セットUnicode (-W)呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

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

LDAP* ldap_openW(
    LPCWSTR HostName,
    DWORD PortNumber
);

パラメーター

名前方向説明
HostNameLPCWSTRinnull で終わる文字列へのポインター。ドメイン名、ホスト名のリスト、または LDAP サーバー ホストの IP アドレスを表すドット区切りの文字列を指定します。リスト内のホスト名は、単一の空白で区切ります。リスト内の各ホスト名の後には、ポート番号を続けることができます。省略可能なポート番号は、コロン (:) でホスト自体と区切ります。LDAP ランタイムは、リストに記載された順序でホストへの接続を試み、接続に成功した時点で停止します。呼び出し元に戻る前に接続を試みるのは ldap_open のみである点に注意してください。 ldap_init 関数は LDAP サーバーへの接続を行いません。
PortNumberDWORDin接続先の TCP ポート番号を格納します。既定の LDAP ポートである 389 は、定数 LDAP_PORT を指定することで取得できます。ホスト名にポート番号が含まれている場合、このパラメーターは無視されます。

戻り値の型: LDAP*

公式ドキュメント

ldap_openW (Unicode) 関数は、接続ブロックを作成して初期化し、LDAP サーバーへの接続を開きます。この関数の使用は推奨されません。代わりに ldap_initW (Unicode) 関数を使用してください。

戻り値

関数が成功した場合、LDAP データ構造体へのポインターの形式でセッション ハンドルを返します。セッション ハンドルが不要になったら、ldap_unbind の呼び出しによって解放してください。

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

解説(Remarks)

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

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

既定の LDAP サーバーは、LDAP_OPT_HOST_NAME を使用する場合の Microsoft 固有のオプションです。このオプションは既定の LDAP サーバーのホスト名を指定し、ldap_get_optionWldap_get_optionA のどちらを使用したかに応じて、Unicode または ANSI でサーバーのホスト名を返します。

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

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

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

注意 ldap_open は、現行の LDAP RFC において強く非推奨とされています。これは、呼び出し元アプリケーションにセッション オプション (たとえば、最も重要なものとしてセキュリティ関連のセッション オプション) を構成する機会を与えないまま、ドメイン コントローラーへのセッションを直ちに開いてしまうためです。LDAP セッションを初期化する推奨される方法として、 ldap_init の使用が推奨されます。
メモ

winldap.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ldap_open を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイル エラーや実行時エラーの原因となる場合があります。詳細については、「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>

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

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_openW = Fiddle::Function.new(
  lib['ldap_openW'],
  [
    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_openW(
        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_openW([MarshalAs(UnmanagedType.LPWStr)] string HostName, uint PortNumber);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_openW' -Namespace Win32 -PassThru
# $api::ldap_openW(HostName, PortNumber)
#uselib "WLDAP32.dll"
#func global ldap_openW "ldap_openW" wptr, wptr
; ldap_openW HostName, PortNumber   ; 戻り値は stat
; HostName : LPCWSTR -> "wptr"
; PortNumber : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WLDAP32.dll"
#cfunc global ldap_openW "ldap_openW" wstr, int
; res = ldap_openW(HostName, PortNumber)
; HostName : LPCWSTR -> "wstr"
; PortNumber : DWORD -> "int"
; LDAP* ldap_openW(LPCWSTR HostName, DWORD PortNumber)
#uselib "WLDAP32.dll"
#cfunc global ldap_openW "ldap_openW" wstr, int
; res = ldap_openW(HostName, PortNumber)
; HostName : LPCWSTR -> "wstr"
; PortNumber : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wldap32 = windows.NewLazySystemDLL("WLDAP32.dll")
	procldap_openW = wldap32.NewProc("ldap_openW")
)

// HostName (LPCWSTR), PortNumber (DWORD)
r1, _, err := procldap_openW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(HostName))),
	uintptr(PortNumber),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LDAP*
function ldap_openW(
  HostName: PWideChar;   // LPCWSTR
  PortNumber: DWORD   // DWORD
): Pointer; cdecl;
  external 'WLDAP32.dll' name 'ldap_openW';
result := DllCall("WLDAP32\ldap_openW"
    , "WStr", HostName   ; LPCWSTR
    , "UInt", PortNumber   ; DWORD
    , "Cdecl Ptr")   ; return: LDAP*
●ldap_openW(HostName, PortNumber) = DLL("WLDAP32.dll", "void* ldap_openW(char*, dword)")
# 呼び出し: ldap_openW(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_openW(
    HostName: [*c]const u16, // LPCWSTR
    PortNumber: u32 // DWORD
) callconv(.c) [*c]LDAP;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ldap_openW(
    HostName: WideCString,  # LPCWSTR
    PortNumber: uint32  # DWORD
): ptr LDAP {.importc: "ldap_openW", cdecl, dynlib: "WLDAP32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wldap32");
extern(C)
LDAP* ldap_openW(
    const(wchar)* HostName,   // LPCWSTR
    uint PortNumber   // DWORD
);
ccall((:ldap_openW, "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_openW(
    const uint16_t* HostName,
    uint32_t PortNumber);
]]
local wldap32 = ffi.load("wldap32")
-- wldap32.ldap_openW(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_openW = lib.func('__cdecl', 'ldap_openW', 'void *', ['str16', 'uint32_t']);
// ldap_openW(HostName, PortNumber)
// HostName : LPCWSTR -> 'str16'
// PortNumber : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WLDAP32.dll", {
  ldap_openW: { parameters: ["buffer", "u32"], result: "pointer" },
});
// lib.symbols.ldap_openW(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_openW(
    const uint16_t* HostName,
    uint32_t PortNumber);
C, "WLDAP32.dll");
// $ffi->ldap_openW(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_openW(
        WString HostName,   // LPCWSTR
        int PortNumber   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wldap32")]
lib LibWLDAP32
  fun ldap_openW = ldap_openW(
    HostName : UInt16*,   # LPCWSTR
    PortNumber : UInt32   # DWORD
  ) : LDAP*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let ldap_openw =
  foreign "ldap_openW"
    ((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_openW" ldap-open-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_openW = Win32::API::More->new('WLDAP32',
    'LPVOID ldap_openW(LPCWSTR HostName, DWORD PortNumber)');
# my $ret = $ldap_openW->Call($HostName, $PortNumber);
# HostName : LPCWSTR -> LPCWSTR
# PortNumber : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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