ホーム › Networking.Ldap › cldap_open
cldap_open
関数コネクションレスLDAPセッションを開く。
シグネチャ
// WLDAP32.dll (ANSI / -A)
#include <windows.h>
LDAP* cldap_open(
LPSTR HostName,
DWORD PortNumber
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| HostName | LPSTR | in | LDAP サーバーホストのホスト名の一覧、またはその IP アドレスを表すドット区切り文字列を格納した、NULL で終わる文字列へのポインター。一覧内のホスト名は 1 つの空白で区切ります。一覧内の各ホスト名の後にはポート番号を指定できます。省略可能なポート番号は、コロン (:) でホスト自体と区切ります。LDAP ランタイムは、一覧に指定された順序でホストへの接続を試み、接続に成功した時点で停止します。 |
| PortNumber | DWORD | in | 使用するポート番号。ポート番号を指定しない場合、既定では LDAP_PORT として定義されているポート 389 になります。HostName パラメーターにポート番号が含まれている場合、このパラメーターは無視されます。 |
戻り値の型: LDAP*
公式ドキュメント
cldap_open 関数 (winldap.h) は、コネクションレスの User Datagram Protocol (UDP) サービスを介して LDAP サーバーとのセッションを確立します。
戻り値
関数が成功すると、LDAP 構造体へのポインターの形式でセッションハンドルが返されます。セッションハンドルが不要になったら、ldap_unbind を呼び出して解放してください。
関数が失敗した場合、戻り値は NULL です。エラーコードを取得するには、 LdapGetLastError または Win32 関数の GetLastError を呼び出します。
解説(Remarks)
cldap_open 関数は、 ldap_open とは異なり、UDP ベースのコネクションレス LDAP サービス用の接続ブロックを作成します。TCP セッションは維持されません。ldap_open と同様に、cldap_open はセッションの状態データを保持するために LDAP 構造体を割り当て、呼び出し元に戻る前に接続を試みます。この呼び出しはセッションハンドルを返します。セッションハンドルは、セッション中の後続の LDAP 関数呼び出しに渡します。セッションが終了したら、必ず ldap_unbind を使用して、割り当てられたセッションハンドルを解放してください。
UDP 経由の LDAP は、バインドをサポートせず、TLS (SSL) や SASL もサポートしません。
マルチスレッド: cldap_open の呼び出しはスレッドセーフです。
メモ cldap_open を使用する場合、接続は匿名ユーザーによって開かれます。実行できる操作は、匿名ユーザーが実行できるものに限られます。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WLDAP32.dll (ANSI / -A)
#include <windows.h>
LDAP* cldap_open(
LPSTR HostName,
DWORD PortNumber
);[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern IntPtr cldap_open(
[MarshalAs(UnmanagedType.LPStr)] string HostName, // LPSTR
uint PortNumber // DWORD
);<DllImport("WLDAP32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function cldap_open(
<MarshalAs(UnmanagedType.LPStr)> HostName As String, ' LPSTR
PortNumber As UInteger ' DWORD
) As IntPtr
End Function' HostName : LPSTR
' PortNumber : DWORD
Declare PtrSafe Function cldap_open 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
cldap_open = ctypes.cdll.wldap32.cldap_open
cldap_open.restype = ctypes.c_void_p
cldap_open.argtypes = [
wintypes.LPCSTR, # HostName : LPSTR
wintypes.DWORD, # PortNumber : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WLDAP32.dll')
cldap_open = Fiddle::Function.new(
lib['cldap_open'],
[
Fiddle::TYPE_VOIDP, # HostName : LPSTR
-Fiddle::TYPE_INT, # PortNumber : DWORD
],
Fiddle::TYPE_VOIDP, Fiddle::Function::CDECL)#[link(name = "wldap32")]
extern "C" {
fn cldap_open(
HostName: *mut u8, // LPSTR
PortNumber: u32 // DWORD
) -> *mut LDAP;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr cldap_open([MarshalAs(UnmanagedType.LPStr)] string HostName, uint PortNumber);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_cldap_open' -Namespace Win32 -PassThru
# $api::cldap_open(HostName, PortNumber)#uselib "WLDAP32.dll"
#func global cldap_open "cldap_open" sptr, sptr
; cldap_open HostName, PortNumber ; 戻り値は stat
; HostName : LPSTR -> "sptr"
; PortNumber : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WLDAP32.dll"
#cfunc global cldap_open "cldap_open" str, int
; res = cldap_open(HostName, PortNumber)
; HostName : LPSTR -> "str"
; PortNumber : DWORD -> "int"; LDAP* cldap_open(LPSTR HostName, DWORD PortNumber)
#uselib "WLDAP32.dll"
#cfunc global cldap_open "cldap_open" str, int
; res = cldap_open(HostName, PortNumber)
; HostName : LPSTR -> "str"
; PortNumber : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
wldap32 = windows.NewLazySystemDLL("WLDAP32.dll")
proccldap_open = wldap32.NewProc("cldap_open")
)
// HostName (LPSTR), PortNumber (DWORD)
r1, _, err := proccldap_open.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(HostName))),
uintptr(PortNumber),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // LDAP*function cldap_open(
HostName: PAnsiChar; // LPSTR
PortNumber: DWORD // DWORD
): Pointer; cdecl;
external 'WLDAP32.dll' name 'cldap_open';result := DllCall("WLDAP32\cldap_open"
, "AStr", HostName ; LPSTR
, "UInt", PortNumber ; DWORD
, "Cdecl Ptr") ; return: LDAP*●cldap_open(HostName, PortNumber) = DLL("WLDAP32.dll", "void* cldap_open(char*, dword)")
# 呼び出し: cldap_open(HostName, PortNumber)
# HostName : LPSTR -> "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 cldap_open(
HostName: [*c]const u8, // LPSTR
PortNumber: u32 // DWORD
) callconv(.c) [*c]LDAP;proc cldap_open(
HostName: cstring, # LPSTR
PortNumber: uint32 # DWORD
): ptr LDAP {.importc: "cldap_open", cdecl, dynlib: "WLDAP32.dll".}pragma(lib, "wldap32");
extern(C)
LDAP* cldap_open(
const(char)* HostName, // LPSTR
uint PortNumber // DWORD
);ccall((:cldap_open, "WLDAP32.dll"), Ptr{LDAP},
(Cstring, UInt32),
HostName, PortNumber)
# HostName : LPSTR -> Cstring
# PortNumber : DWORD -> UInt32local ffi = require("ffi")
ffi.cdef[[
void* cldap_open(
const char* HostName,
uint32_t PortNumber);
]]
local wldap32 = ffi.load("wldap32")
-- wldap32.cldap_open(HostName, PortNumber)
-- HostName : LPSTR
-- PortNumber : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WLDAP32.dll');
const cldap_open = lib.func('__cdecl', 'cldap_open', 'void *', ['str', 'uint32_t']);
// cldap_open(HostName, PortNumber)
// HostName : LPSTR -> 'str'
// PortNumber : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WLDAP32.dll", {
cldap_open: { parameters: ["buffer", "u32"], result: "pointer" },
});
// lib.symbols.cldap_open(HostName, PortNumber)
// HostName : LPSTR -> "buffer"
// PortNumber : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* cldap_open(
const char* HostName,
uint32_t PortNumber);
C, "WLDAP32.dll");
// $ffi->cldap_open(HostName, PortNumber);
// HostName : LPSTR
// 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 cldap_open(
String HostName, // LPSTR
int PortNumber // DWORD
);
}@[Link("wldap32")]
lib LibWLDAP32
fun cldap_open = cldap_open(
HostName : UInt8*, # LPSTR
PortNumber : UInt32 # DWORD
) : LDAP*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef cldap_openNative = Pointer<Void> Function(Pointer<Utf8>, Uint32);
typedef cldap_openDart = Pointer<Void> Function(Pointer<Utf8>, int);
final cldap_open = DynamicLibrary.open('WLDAP32.dll')
.lookupFunction<cldap_openNative, cldap_openDart>('cldap_open');
// HostName : LPSTR -> Pointer<Utf8>
// PortNumber : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function cldap_open(
HostName: PAnsiChar; // LPSTR
PortNumber: DWORD // DWORD
): Pointer; cdecl;
external 'WLDAP32.dll' name 'cldap_open';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import ccall safe "cldap_open"
c_cldap_open :: CString -> Word32 -> IO (Ptr ())
-- HostName : LPSTR -> CString
-- PortNumber : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let cldap_open =
foreign "cldap_open"
(string @-> uint32_t @-> returning (ptr void))
(* HostName : LPSTR -> 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 ("cldap_open" cldap-open :convention :cdecl) :pointer
(host-name :string) ; LPSTR
(port-number :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $cldap_open = Win32::API::More->new('WLDAP32',
'LPVOID cldap_open(LPCSTR HostName, DWORD PortNumber)');
# my $ret = $cldap_open->Call($HostName, $PortNumber);
# HostName : LPSTR -> LPCSTR
# PortNumber : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f cldap_openA (ANSI版) — コネクションレスLDAPセッションを開く(ANSI版)。
- f cldap_openW (Unicode版) — コネクションレスLDAPセッションを開く(Unicode版)。
公式の関連項目
- f GetLastError — 呼び出しスレッドの最終エラーコードを取得する。
- f LdapGetLastError — 直前のLDAP呼び出しのエラーコードを取得する。
- f ldap_openA — LDAPサーバーへの接続を開く(ANSI版)。
- f ldap_unbind — LDAPセッションを切断し資源を解放する。
使用する型