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

ldap_set_optionW

関数
LDAPセッションのオプション値を設定する(Unicode版)。
DLLWLDAP32.dll文字セットUnicode (-W)呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

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

DWORD ldap_set_optionW(
    LDAP* ld,
    INT option,
    const void* invalue
);

パラメーター

名前方向説明
ldLDAP*inoutオプションを設定する対象のLDAPセッションハンドル。
optionINTin設定するセッションオプションの識別子。LDAP_OPT_PROTOCOL_VERSION等の定数を指定する。
invaluevoid*in設定する値(Unicode)を保持するバッファへのポインタ。ON/OFFはLDAP_OPT_ON/OFFを指す。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ldap_set_optionW(
    LDAP* ld,
    INT option,
    const void* invalue
);
[DllImport("WLDAP32.dll", CharSet = CharSet.Unicode, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern uint ldap_set_optionW(
    IntPtr ld,   // LDAP* in/out
    int option,   // INT
    IntPtr invalue   // void*
);
<DllImport("WLDAP32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_set_optionW(
    ld As IntPtr,   ' LDAP* in/out
    [option] As Integer,   ' INT
    invalue As IntPtr   ' void*
) As UInteger
End Function
' ld : LDAP* in/out
' option : INT
' invalue : void*
Declare PtrSafe Function ldap_set_optionW Lib "wldap32" ( _
    ByVal ld As LongPtr, _
    ByVal option As Long, _
    ByVal invalue As LongPtr) As Long
' 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_set_optionW = ctypes.cdll.wldap32.ldap_set_optionW
ldap_set_optionW.restype = wintypes.DWORD
ldap_set_optionW.argtypes = [
    ctypes.c_void_p,  # ld : LDAP* in/out
    ctypes.c_int,  # option : INT
    ctypes.POINTER(None),  # invalue : void*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_set_optionW = Fiddle::Function.new(
  lib['ldap_set_optionW'],
  [
    Fiddle::TYPE_VOIDP,  # ld : LDAP* in/out
    Fiddle::TYPE_INT,  # option : INT
    Fiddle::TYPE_VOIDP,  # invalue : void*
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wldap32")]
extern "C" {
    fn ldap_set_optionW(
        ld: *mut LDAP,  // LDAP* in/out
        option: i32,  // INT
        invalue: *const ()  // void*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WLDAP32.dll", CharSet = CharSet.Unicode, CallingConvention = CallingConvention.Cdecl)]
public static extern uint ldap_set_optionW(IntPtr ld, int option, IntPtr invalue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_set_optionW' -Namespace Win32 -PassThru
# $api::ldap_set_optionW(ld, option, invalue)
#uselib "WLDAP32.dll"
#func global ldap_set_optionW "ldap_set_optionW" wptr, wptr, wptr
; ldap_set_optionW varptr(ld), option, invalue   ; 戻り値は stat
; ld : LDAP* in/out -> "wptr"
; option : INT -> "wptr"
; invalue : void* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WLDAP32.dll"
#cfunc global ldap_set_optionW "ldap_set_optionW" var, int, sptr
; res = ldap_set_optionW(ld, option, invalue)
; ld : LDAP* in/out -> "var"
; option : INT -> "int"
; invalue : void* -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD ldap_set_optionW(LDAP* ld, INT option, void* invalue)
#uselib "WLDAP32.dll"
#cfunc global ldap_set_optionW "ldap_set_optionW" var, int, intptr
; res = ldap_set_optionW(ld, option, invalue)
; ld : LDAP* in/out -> "var"
; option : INT -> "int"
; invalue : void* -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wldap32 = windows.NewLazySystemDLL("WLDAP32.dll")
	procldap_set_optionW = wldap32.NewProc("ldap_set_optionW")
)

// ld (LDAP* in/out), option (INT), invalue (void*)
r1, _, err := procldap_set_optionW.Call(
	uintptr(ld),
	uintptr(option),
	uintptr(invalue),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ldap_set_optionW(
  ld: Pointer;   // LDAP* in/out
  option: Integer;   // INT
  invalue: Pointer   // void*
): DWORD; cdecl;
  external 'WLDAP32.dll' name 'ldap_set_optionW';
result := DllCall("WLDAP32\ldap_set_optionW"
    , "Ptr", ld   ; LDAP* in/out
    , "Int", option   ; INT
    , "Ptr", invalue   ; void*
    , "Cdecl UInt")   ; return: DWORD
●ldap_set_optionW(ld, option, invalue) = DLL("WLDAP32.dll", "dword ldap_set_optionW(void*, int, void*)")
# 呼び出し: ldap_set_optionW(ld, option, invalue)
# ld : LDAP* in/out -> "void*"
# option : INT -> "int"
# invalue : void* -> "void*"
# なでしこ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_set_optionW(
    ld: [*c]LDAP, // LDAP* in/out
    option: i32, // INT
    invalue: ?*anyopaque // void*
) callconv(.c) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ldap_set_optionW(
    ld: ptr LDAP,  # LDAP* in/out
    option: int32,  # INT
    invalue: pointer  # void*
): uint32 {.importc: "ldap_set_optionW", cdecl, dynlib: "WLDAP32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wldap32");
extern(C)
uint ldap_set_optionW(
    LDAP* ld,   // LDAP* in/out
    int option,   // INT
    void* invalue   // void*
);
ccall((:ldap_set_optionW, "WLDAP32.dll"), UInt32,
      (Ptr{LDAP}, Int32, Ptr{Cvoid}),
      ld, option, invalue)
# ld : LDAP* in/out -> Ptr{LDAP}
# option : INT -> Int32
# invalue : void* -> Ptr{Cvoid}
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ldap_set_optionW(
    void* ld,
    int32_t option,
    void* invalue);
]]
local wldap32 = ffi.load("wldap32")
-- wldap32.ldap_set_optionW(ld, option, invalue)
-- ld : LDAP* in/out
-- option : INT
-- invalue : void*
-- 構造体/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_set_optionW = lib.func('__cdecl', 'ldap_set_optionW', 'uint32_t', ['void *', 'int32_t', 'void *']);
// ldap_set_optionW(ld, option, invalue)
// ld : LDAP* in/out -> 'void *'
// option : INT -> 'int32_t'
// invalue : void* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WLDAP32.dll", {
  ldap_set_optionW: { parameters: ["pointer", "i32", "pointer"], result: "u32" },
});
// lib.symbols.ldap_set_optionW(ld, option, invalue)
// ld : LDAP* in/out -> "pointer"
// option : INT -> "i32"
// invalue : void* -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ldap_set_optionW(
    void* ld,
    int32_t option,
    void* invalue);
C, "WLDAP32.dll");
// $ffi->ldap_set_optionW(ld, option, invalue);
// ld : LDAP* in/out
// option : INT
// invalue : void*
// 構造体/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);
    int ldap_set_optionW(
        Pointer ld,   // LDAP* in/out
        int option,   // INT
        Pointer invalue   // void*
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wldap32")]
lib LibWLDAP32
  fun ldap_set_optionW = ldap_set_optionW(
    ld : LDAP*,   # LDAP* in/out
    option : Int32,   # INT
    invalue : Void*   # void*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ldap_set_optionWNative = Uint32 Function(Pointer<Void>, Int32, Pointer<Void>);
typedef ldap_set_optionWDart = int Function(Pointer<Void>, int, Pointer<Void>);
final ldap_set_optionW = DynamicLibrary.open('WLDAP32.dll')
    .lookupFunction<ldap_set_optionWNative, ldap_set_optionWDart>('ldap_set_optionW');
// ld : LDAP* in/out -> Pointer<Void>
// option : INT -> Int32
// invalue : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ldap_set_optionW(
  ld: Pointer;   // LDAP* in/out
  option: Integer;   // INT
  invalue: Pointer   // void*
): DWORD; cdecl;
  external 'WLDAP32.dll' name 'ldap_set_optionW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "ldap_set_optionW"
  c_ldap_set_optionW :: Ptr () -> Int32 -> Ptr () -> IO Word32
-- ld : LDAP* in/out -> Ptr ()
-- option : INT -> Int32
-- invalue : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ldap_set_optionw =
  foreign "ldap_set_optionW"
    ((ptr void) @-> int32_t @-> (ptr void) @-> returning uint32_t)
(* ld : LDAP* in/out -> (ptr void) *)
(* option : INT -> int32_t *)
(* invalue : void* -> (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_set_optionW" ldap-set-option-w :convention :cdecl) :uint32
  (ld :pointer)   ; LDAP* in/out
  (option :int32)   ; INT
  (invalue :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ldap_set_optionW = Win32::API::More->new('WLDAP32',
    'DWORD ldap_set_optionW(LPVOID ld, int option, LPVOID invalue)');
# my $ret = $ldap_set_optionW->Call($ld, $option, $invalue);
# ld : LDAP* in/out -> LPVOID
# option : INT -> int
# invalue : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

使用する型