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

ldap_parse_page_controlW

関数
ページ検索結果コントロールから件数とクッキーを解析する(Unicode版)。
DLLWLDAP32.dll文字セットUnicode (-W)呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

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

DWORD ldap_parse_page_controlW(
    LDAP* ExternalHandle,
    LDAPControlW** ServerControls,
    DWORD* TotalCount,
    LDAP_BERVAL** Cookie
);

パラメーター

名前方向説明
ExternalHandleLDAP*inout対象のLDAPセッションハンドル。応答を受信した接続を指す。
ServerControlsLDAPControlW**inoutサーバから返されたコントロール配列。ページング結果コントロールを含む入力。
TotalCountDWORD*inoutサーバが見積もった総エントリ数を受け取る出力先。
CookieLDAP_BERVAL**inout次ページ取得に使うページングクッキー(berval)を受け取る出力先。ber_bvfreeで解放。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ldap_parse_page_controlW(
    LDAP* ExternalHandle,
    LDAPControlW** ServerControls,
    DWORD* TotalCount,
    LDAP_BERVAL** Cookie
);
[DllImport("WLDAP32.dll", CharSet = CharSet.Unicode, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern uint ldap_parse_page_controlW(
    IntPtr ExternalHandle,   // LDAP* in/out
    IntPtr ServerControls,   // LDAPControlW** in/out
    ref uint TotalCount,   // DWORD* in/out
    IntPtr Cookie   // LDAP_BERVAL** in/out
);
<DllImport("WLDAP32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_parse_page_controlW(
    ExternalHandle As IntPtr,   ' LDAP* in/out
    ServerControls As IntPtr,   ' LDAPControlW** in/out
    ByRef TotalCount As UInteger,   ' DWORD* in/out
    Cookie As IntPtr   ' LDAP_BERVAL** in/out
) As UInteger
End Function
' ExternalHandle : LDAP* in/out
' ServerControls : LDAPControlW** in/out
' TotalCount : DWORD* in/out
' Cookie : LDAP_BERVAL** in/out
Declare PtrSafe Function ldap_parse_page_controlW Lib "wldap32" ( _
    ByVal ExternalHandle As LongPtr, _
    ByVal ServerControls As LongPtr, _
    ByRef TotalCount As Long, _
    ByVal Cookie 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_parse_page_controlW = ctypes.cdll.wldap32.ldap_parse_page_controlW
ldap_parse_page_controlW.restype = wintypes.DWORD
ldap_parse_page_controlW.argtypes = [
    ctypes.c_void_p,  # ExternalHandle : LDAP* in/out
    ctypes.c_void_p,  # ServerControls : LDAPControlW** in/out
    ctypes.POINTER(wintypes.DWORD),  # TotalCount : DWORD* in/out
    ctypes.c_void_p,  # Cookie : LDAP_BERVAL** in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_parse_page_controlW = Fiddle::Function.new(
  lib['ldap_parse_page_controlW'],
  [
    Fiddle::TYPE_VOIDP,  # ExternalHandle : LDAP* in/out
    Fiddle::TYPE_VOIDP,  # ServerControls : LDAPControlW** in/out
    Fiddle::TYPE_VOIDP,  # TotalCount : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # Cookie : LDAP_BERVAL** in/out
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wldap32")]
extern "C" {
    fn ldap_parse_page_controlW(
        ExternalHandle: *mut LDAP,  // LDAP* in/out
        ServerControls: *mut *mut LDAPControlW,  // LDAPControlW** in/out
        TotalCount: *mut u32,  // DWORD* in/out
        Cookie: *mut *mut LDAP_BERVAL  // LDAP_BERVAL** in/out
    ) -> 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_parse_page_controlW(IntPtr ExternalHandle, IntPtr ServerControls, ref uint TotalCount, IntPtr Cookie);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_parse_page_controlW' -Namespace Win32 -PassThru
# $api::ldap_parse_page_controlW(ExternalHandle, ServerControls, TotalCount, Cookie)
#uselib "WLDAP32.dll"
#func global ldap_parse_page_controlW "ldap_parse_page_controlW" wptr, wptr, wptr, wptr
; ldap_parse_page_controlW varptr(ExternalHandle), varptr(ServerControls), varptr(TotalCount), varptr(Cookie)   ; 戻り値は stat
; ExternalHandle : LDAP* in/out -> "wptr"
; ServerControls : LDAPControlW** in/out -> "wptr"
; TotalCount : DWORD* in/out -> "wptr"
; Cookie : LDAP_BERVAL** in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WLDAP32.dll"
#cfunc global ldap_parse_page_controlW "ldap_parse_page_controlW" var, var, var, var
; res = ldap_parse_page_controlW(ExternalHandle, ServerControls, TotalCount, Cookie)
; ExternalHandle : LDAP* in/out -> "var"
; ServerControls : LDAPControlW** in/out -> "var"
; TotalCount : DWORD* in/out -> "var"
; Cookie : LDAP_BERVAL** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD ldap_parse_page_controlW(LDAP* ExternalHandle, LDAPControlW** ServerControls, DWORD* TotalCount, LDAP_BERVAL** Cookie)
#uselib "WLDAP32.dll"
#cfunc global ldap_parse_page_controlW "ldap_parse_page_controlW" var, var, var, var
; res = ldap_parse_page_controlW(ExternalHandle, ServerControls, TotalCount, Cookie)
; ExternalHandle : LDAP* in/out -> "var"
; ServerControls : LDAPControlW** in/out -> "var"
; TotalCount : DWORD* in/out -> "var"
; Cookie : LDAP_BERVAL** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wldap32 = windows.NewLazySystemDLL("WLDAP32.dll")
	procldap_parse_page_controlW = wldap32.NewProc("ldap_parse_page_controlW")
)

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

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

foreign import ccall safe "ldap_parse_page_controlW"
  c_ldap_parse_page_controlW :: Ptr () -> Ptr () -> Ptr Word32 -> Ptr () -> IO Word32
-- ExternalHandle : LDAP* in/out -> Ptr ()
-- ServerControls : LDAPControlW** in/out -> Ptr ()
-- TotalCount : DWORD* in/out -> Ptr Word32
-- Cookie : LDAP_BERVAL** in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ldap_parse_page_controlw =
  foreign "ldap_parse_page_controlW"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> returning uint32_t)
(* ExternalHandle : LDAP* in/out -> (ptr void) *)
(* ServerControls : LDAPControlW** in/out -> (ptr void) *)
(* TotalCount : DWORD* in/out -> (ptr uint32_t) *)
(* Cookie : LDAP_BERVAL** 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_parse_page_controlW" ldap-parse-page-control-w :convention :cdecl) :uint32
  (external-handle :pointer)   ; LDAP* in/out
  (server-controls :pointer)   ; LDAPControlW** in/out
  (total-count :pointer)   ; DWORD* in/out
  (cookie :pointer))   ; LDAP_BERVAL** in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ldap_parse_page_controlW = Win32::API::More->new('WLDAP32',
    'DWORD ldap_parse_page_controlW(LPVOID ExternalHandle, LPVOID ServerControls, LPVOID TotalCount, LPVOID Cookie)');
# my $ret = $ldap_parse_page_controlW->Call($ExternalHandle, $ServerControls, $TotalCount, $Cookie);
# ExternalHandle : LDAP* in/out -> LPVOID
# ServerControls : LDAPControlW** in/out -> LPVOID
# TotalCount : DWORD* in/out -> LPVOID
# Cookie : LDAP_BERVAL** in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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