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

ldap_initA

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

シグネチャ

// WLDAP32.dll  (ANSI / -A)
#include <windows.h>

LDAP* ldap_initA(
    LPCSTR HostName,
    DWORD PortNumber
);

パラメーター

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

戻り値の型: LDAP*

公式ドキュメント

LDAP サーバーとのセッションを初期化します。(ldap_initA)

戻り値

関数が成功した場合は、 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 に渡される場合、内部で呼び出される DsGetDcName() がエンタープライズ内の GC を正しく検出できるように、そのポート番号に対して渡す HostName はフォレストの名前でなければなりません。

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

ldap_init は、LDAP セッションを初期化する推奨される方法です。ldap_open の使用は、セッション オプションを設定できなくなるため、現行の LDAP RFC で強く非推奨とされています。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WLDAP32.dll  (ANSI / -A)
#include <windows.h>

LDAP* ldap_initA(
    LPCSTR HostName,
    DWORD PortNumber
);
[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern IntPtr ldap_initA(
    [MarshalAs(UnmanagedType.LPStr)] string HostName,   // LPCSTR
    uint PortNumber   // DWORD
);
<DllImport("WLDAP32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_initA(
    <MarshalAs(UnmanagedType.LPStr)> HostName As String,   ' LPCSTR
    PortNumber As UInteger   ' DWORD
) As IntPtr
End Function
' HostName : LPCSTR
' PortNumber : DWORD
Declare PtrSafe Function ldap_initA Lib "wldap32" ( _
    ByVal HostName As String, _
    ByVal PortNumber As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ldap_initA = ctypes.cdll.wldap32.ldap_initA
ldap_initA.restype = ctypes.c_void_p
ldap_initA.argtypes = [
    wintypes.LPCSTR,  # HostName : LPCSTR
    wintypes.DWORD,  # PortNumber : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wldap32 = windows.NewLazySystemDLL("WLDAP32.dll")
	procldap_initA = wldap32.NewProc("ldap_initA")
)

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

extern "wldap32" fn ldap_initA(
    HostName: [*c]const u8, // LPCSTR
    PortNumber: u32 // DWORD
) callconv(.c) [*c]LDAP;
proc ldap_initA(
    HostName: cstring,  # LPCSTR
    PortNumber: uint32  # DWORD
): ptr LDAP {.importc: "ldap_initA", cdecl, dynlib: "WLDAP32.dll".}
pragma(lib, "wldap32");
extern(C)
LDAP* ldap_initA(
    const(char)* HostName,   // LPCSTR
    uint PortNumber   // DWORD
);
ccall((:ldap_initA, "WLDAP32.dll"), Ptr{LDAP},
      (Cstring, UInt32),
      HostName, PortNumber)
# HostName : LPCSTR -> Cstring
# PortNumber : DWORD -> UInt32
local ffi = require("ffi")
ffi.cdef[[
void* ldap_initA(
    const char* HostName,
    uint32_t PortNumber);
]]
local wldap32 = ffi.load("wldap32")
-- wldap32.ldap_initA(HostName, PortNumber)
-- HostName : LPCSTR
-- PortNumber : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WLDAP32.dll');
const ldap_initA = lib.func('__cdecl', 'ldap_initA', 'void *', ['str', 'uint32_t']);
// ldap_initA(HostName, PortNumber)
// HostName : LPCSTR -> 'str'
// PortNumber : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WLDAP32.dll", {
  ldap_initA: { parameters: ["buffer", "u32"], result: "pointer" },
});
// lib.symbols.ldap_initA(HostName, PortNumber)
// HostName : LPCSTR -> "buffer"
// PortNumber : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* ldap_initA(
    const char* HostName,
    uint32_t PortNumber);
C, "WLDAP32.dll");
// $ffi->ldap_initA(HostName, PortNumber);
// HostName : LPCSTR
// 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.ASCII_OPTIONS);
    Pointer ldap_initA(
        String HostName,   // LPCSTR
        int PortNumber   // DWORD
    );
}
@[Link("wldap32")]
lib LibWLDAP32
  fun ldap_initA = ldap_initA(
    HostName : UInt8*,   # LPCSTR
    PortNumber : UInt32   # DWORD
  ) : LDAP*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let ldap_inita =
  foreign "ldap_initA"
    (string @-> uint32_t @-> returning (ptr void))
(* HostName : LPCSTR -> string *)
(* 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_initA" ldap-init-a :convention :cdecl) :pointer
  (host-name :string)   ; LPCSTR
  (port-number :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ldap_initA = Win32::API::More->new('WLDAP32',
    'LPVOID ldap_initA(LPCSTR HostName, DWORD PortNumber)');
# my $ret = $ldap_initA->Call($HostName, $PortNumber);
# HostName : LPCSTR -> LPCSTR
# PortNumber : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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