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

ldap_start_tls_sA

関数
LDAP接続でTLSセッションを同期的に開始する(ANSI版)。
DLLWLDAP32.dll文字セットANSI (-A)呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

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

DWORD ldap_start_tls_sA(
    LDAP* ExternalHandle,
    DWORD* ServerReturnValue,
    LDAPMessage** result,
    LDAPControlA** ServerControls,
    LDAPControlA** ClientControls
);

パラメーター

名前方向説明
ExternalHandleLDAP*inout対象のLDAPセッションハンドル。TLSを開始する接続を指す。
ServerReturnValueDWORD*inoutサーバからの戻り値(エラーコード)を受け取る出力先。
resultLDAPMessage**inoutサーバの拡張応答メッセージを受け取る出力先。ldap_msgfreeで解放する。
ServerControlsLDAPControlA**inoutリクエストに付加するサーバサイドコントロール配列。NULL可。
ClientControlsLDAPControlA**inoutリクエストに付加するクライアントサイドコントロール配列。NULL可。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ldap_start_tls_sA(
    LDAP* ExternalHandle,
    DWORD* ServerReturnValue,
    LDAPMessage** result,
    LDAPControlA** ServerControls,
    LDAPControlA** ClientControls
);
[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern uint ldap_start_tls_sA(
    IntPtr ExternalHandle,   // LDAP* in/out
    ref uint ServerReturnValue,   // DWORD* in/out
    IntPtr result,   // LDAPMessage** in/out
    IntPtr ServerControls,   // LDAPControlA** in/out
    IntPtr ClientControls   // LDAPControlA** in/out
);
<DllImport("WLDAP32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_start_tls_sA(
    ExternalHandle As IntPtr,   ' LDAP* in/out
    ByRef ServerReturnValue As UInteger,   ' DWORD* in/out
    result As IntPtr,   ' LDAPMessage** in/out
    ServerControls As IntPtr,   ' LDAPControlA** in/out
    ClientControls As IntPtr   ' LDAPControlA** in/out
) As UInteger
End Function
' ExternalHandle : LDAP* in/out
' ServerReturnValue : DWORD* in/out
' result : LDAPMessage** in/out
' ServerControls : LDAPControlA** in/out
' ClientControls : LDAPControlA** in/out
Declare PtrSafe Function ldap_start_tls_sA Lib "wldap32" ( _
    ByVal ExternalHandle As LongPtr, _
    ByRef ServerReturnValue As Long, _
    ByVal result As LongPtr, _
    ByVal ServerControls As LongPtr, _
    ByVal ClientControls As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ldap_start_tls_sA = ctypes.cdll.wldap32.ldap_start_tls_sA
ldap_start_tls_sA.restype = wintypes.DWORD
ldap_start_tls_sA.argtypes = [
    ctypes.c_void_p,  # ExternalHandle : LDAP* in/out
    ctypes.POINTER(wintypes.DWORD),  # ServerReturnValue : DWORD* in/out
    ctypes.c_void_p,  # result : LDAPMessage** in/out
    ctypes.c_void_p,  # ServerControls : LDAPControlA** in/out
    ctypes.c_void_p,  # ClientControls : LDAPControlA** in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_start_tls_sA = Fiddle::Function.new(
  lib['ldap_start_tls_sA'],
  [
    Fiddle::TYPE_VOIDP,  # ExternalHandle : LDAP* in/out
    Fiddle::TYPE_VOIDP,  # ServerReturnValue : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # result : LDAPMessage** in/out
    Fiddle::TYPE_VOIDP,  # ServerControls : LDAPControlA** in/out
    Fiddle::TYPE_VOIDP,  # ClientControls : LDAPControlA** in/out
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)
#[link(name = "wldap32")]
extern "C" {
    fn ldap_start_tls_sA(
        ExternalHandle: *mut LDAP,  // LDAP* in/out
        ServerReturnValue: *mut u32,  // DWORD* in/out
        result: *mut *mut LDAPMessage,  // LDAPMessage** in/out
        ServerControls: *mut *mut LDAPControlA,  // LDAPControlA** in/out
        ClientControls: *mut *mut LDAPControlA  // LDAPControlA** in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, CallingConvention = CallingConvention.Cdecl)]
public static extern uint ldap_start_tls_sA(IntPtr ExternalHandle, ref uint ServerReturnValue, IntPtr result, IntPtr ServerControls, IntPtr ClientControls);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_start_tls_sA' -Namespace Win32 -PassThru
# $api::ldap_start_tls_sA(ExternalHandle, ServerReturnValue, result, ServerControls, ClientControls)
#uselib "WLDAP32.dll"
#func global ldap_start_tls_sA "ldap_start_tls_sA" sptr, sptr, sptr, sptr, sptr
; ldap_start_tls_sA varptr(ExternalHandle), varptr(ServerReturnValue), varptr(result), varptr(ServerControls), varptr(ClientControls)   ; 戻り値は stat
; ExternalHandle : LDAP* in/out -> "sptr"
; ServerReturnValue : DWORD* in/out -> "sptr"
; result : LDAPMessage** in/out -> "sptr"
; ServerControls : LDAPControlA** in/out -> "sptr"
; ClientControls : LDAPControlA** in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WLDAP32.dll"
#cfunc global ldap_start_tls_sA "ldap_start_tls_sA" var, var, var, var, var
; res = ldap_start_tls_sA(ExternalHandle, ServerReturnValue, result, ServerControls, ClientControls)
; ExternalHandle : LDAP* in/out -> "var"
; ServerReturnValue : DWORD* in/out -> "var"
; result : LDAPMessage** in/out -> "var"
; ServerControls : LDAPControlA** in/out -> "var"
; ClientControls : LDAPControlA** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD ldap_start_tls_sA(LDAP* ExternalHandle, DWORD* ServerReturnValue, LDAPMessage** result, LDAPControlA** ServerControls, LDAPControlA** ClientControls)
#uselib "WLDAP32.dll"
#cfunc global ldap_start_tls_sA "ldap_start_tls_sA" var, var, var, var, var
; res = ldap_start_tls_sA(ExternalHandle, ServerReturnValue, result, ServerControls, ClientControls)
; ExternalHandle : LDAP* in/out -> "var"
; ServerReturnValue : DWORD* in/out -> "var"
; result : LDAPMessage** in/out -> "var"
; ServerControls : LDAPControlA** in/out -> "var"
; ClientControls : LDAPControlA** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wldap32 = windows.NewLazySystemDLL("WLDAP32.dll")
	procldap_start_tls_sA = wldap32.NewProc("ldap_start_tls_sA")
)

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

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

typedef ldap_start_tls_sANative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef ldap_start_tls_sADart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final ldap_start_tls_sA = DynamicLibrary.open('WLDAP32.dll')
    .lookupFunction<ldap_start_tls_sANative, ldap_start_tls_sADart>('ldap_start_tls_sA');
// ExternalHandle : LDAP* in/out -> Pointer<Void>
// ServerReturnValue : DWORD* in/out -> Pointer<Uint32>
// result : LDAPMessage** in/out -> Pointer<Void>
// ServerControls : LDAPControlA** in/out -> Pointer<Void>
// ClientControls : LDAPControlA** in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ldap_start_tls_sA(
  ExternalHandle: Pointer;   // LDAP* in/out
  ServerReturnValue: Pointer;   // DWORD* in/out
  result: Pointer;   // LDAPMessage** in/out
  ServerControls: Pointer;   // LDAPControlA** in/out
  ClientControls: Pointer   // LDAPControlA** in/out
): DWORD; cdecl;
  external 'WLDAP32.dll' name 'ldap_start_tls_sA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "ldap_start_tls_sA"
  c_ldap_start_tls_sA :: Ptr () -> Ptr Word32 -> Ptr () -> Ptr () -> Ptr () -> IO Word32
-- ExternalHandle : LDAP* in/out -> Ptr ()
-- ServerReturnValue : DWORD* in/out -> Ptr Word32
-- result : LDAPMessage** in/out -> Ptr ()
-- ServerControls : LDAPControlA** in/out -> Ptr ()
-- ClientControls : LDAPControlA** in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ldap_start_tls_sa =
  foreign "ldap_start_tls_sA"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* ExternalHandle : LDAP* in/out -> (ptr void) *)
(* ServerReturnValue : DWORD* in/out -> (ptr uint32_t) *)
(* result : LDAPMessage** in/out -> (ptr void) *)
(* ServerControls : LDAPControlA** in/out -> (ptr void) *)
(* ClientControls : LDAPControlA** in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wldap32 (t "WLDAP32.dll"))
(cffi:use-foreign-library wldap32)

(cffi:defcfun ("ldap_start_tls_sA" ldap-start-tls-s-a :convention :cdecl) :uint32
  (external-handle :pointer)   ; LDAP* in/out
  (server-return-value :pointer)   ; DWORD* in/out
  (result :pointer)   ; LDAPMessage** in/out
  (server-controls :pointer)   ; LDAPControlA** in/out
  (client-controls :pointer))   ; LDAPControlA** in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ldap_start_tls_sA = Win32::API::More->new('WLDAP32',
    'DWORD ldap_start_tls_sA(LPVOID ExternalHandle, LPVOID ServerReturnValue, LPVOID result, LPVOID ServerControls, LPVOID ClientControls)');
# my $ret = $ldap_start_tls_sA->Call($ExternalHandle, $ServerReturnValue, $result, $ServerControls, $ClientControls);
# ExternalHandle : LDAP* in/out -> LPVOID
# ServerReturnValue : DWORD* in/out -> LPVOID
# result : LDAPMessage** in/out -> LPVOID
# ServerControls : LDAPControlA** in/out -> LPVOID
# ClientControls : LDAPControlA** in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型