ホーム › Networking.Ldap › ldap_search_init_pageW

ldap_search_init_pageW

関数

ページ単位のLDAP検索を初期化する(Unicode版)。

DLLWLDAP32.dll文字セットUnicode (-W)呼出規約cdeclSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

PLDAPSearch ldap_search_init_pageW(
    LDAP* ExternalHandle,
    LPCWSTR DistinguishedName,
    DWORD ScopeOfSearch,
    LPCWSTR SearchFilter,
    WORD** AttributeList,
    DWORD AttributesOnly,
    LDAPControlW** ServerControls,
    LDAPControlW** ClientControls,
    DWORD PageTimeLimit,
    DWORD TotalSizeLimit,
    LDAPSortKeyW** SortKeys
);

パラメーター

名前	型	方向	説明
ExternalHandle	LDAP*	inout	対象のLDAPセッションハンドル。ページ検索を開始する接続を指す。
DistinguishedName	LPCWSTR	in	検索の基点となるベースDN(Unicode)。探索ツリーのルートを指定する。
ScopeOfSearch	DWORD	in	検索範囲。base(0)/onelevel(1)/subtree(2)のいずれかを指定する。
SearchFilter	LPCWSTR	in	適用する検索フィルタ文字列(Unicode)。条件式でエントリを絞り込む。
AttributeList	WORD**	in	取得する属性名のNULL終端配列。NULLで全属性を取得する。
AttributesOnly	DWORD	in	0以外なら属性名のみ取得し値は返さない真偽フラグ。0なら値も取得する。
ServerControls	LDAPControlW**	inout	リクエストに付加するサーバサイドコントロール配列。NULL可。
ClientControls	LDAPControlW**	inout	リクエストに付加するクライアントサイドコントロール配列。NULL可。
PageTimeLimit	DWORD	in	1ページ取得あたりの制限時間(秒)。0で無制限。
TotalSizeLimit	DWORD	in	検索全体で返すエントリ総数の上限。0で無制限。
SortKeys	LDAPSortKeyW**	inout	結果のソート条件を表すLDAPSortKeyW配列。不要ならNULL可。

戻り値の型: PLDAPSearch

各言語での呼び出し定義

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

PLDAPSearch ldap_search_init_pageW(
    LDAP* ExternalHandle,
    LPCWSTR DistinguishedName,
    DWORD ScopeOfSearch,
    LPCWSTR SearchFilter,
    WORD** AttributeList,
    DWORD AttributesOnly,
    LDAPControlW** ServerControls,
    LDAPControlW** ClientControls,
    DWORD PageTimeLimit,
    DWORD TotalSizeLimit,
    LDAPSortKeyW** SortKeys
);

[DllImport("WLDAP32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern IntPtr ldap_search_init_pageW(
    IntPtr ExternalHandle,   // LDAP* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string DistinguishedName,   // LPCWSTR
    uint ScopeOfSearch,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string SearchFilter,   // LPCWSTR
    IntPtr AttributeList,   // WORD**
    uint AttributesOnly,   // DWORD
    IntPtr ServerControls,   // LDAPControlW** in/out
    IntPtr ClientControls,   // LDAPControlW** in/out
    uint PageTimeLimit,   // DWORD
    uint TotalSizeLimit,   // DWORD
    IntPtr SortKeys   // LDAPSortKeyW** in/out
);

<DllImport("WLDAP32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_search_init_pageW(
    ExternalHandle As IntPtr,   ' LDAP* in/out
    <MarshalAs(UnmanagedType.LPWStr)> DistinguishedName As String,   ' LPCWSTR
    ScopeOfSearch As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> SearchFilter As String,   ' LPCWSTR
    AttributeList As IntPtr,   ' WORD**
    AttributesOnly As UInteger,   ' DWORD
    ServerControls As IntPtr,   ' LDAPControlW** in/out
    ClientControls As IntPtr,   ' LDAPControlW** in/out
    PageTimeLimit As UInteger,   ' DWORD
    TotalSizeLimit As UInteger,   ' DWORD
    SortKeys As IntPtr   ' LDAPSortKeyW** in/out
) As IntPtr
End Function

' ExternalHandle : LDAP* in/out
' DistinguishedName : LPCWSTR
' ScopeOfSearch : DWORD
' SearchFilter : LPCWSTR
' AttributeList : WORD**
' AttributesOnly : DWORD
' ServerControls : LDAPControlW** in/out
' ClientControls : LDAPControlW** in/out
' PageTimeLimit : DWORD
' TotalSizeLimit : DWORD
' SortKeys : LDAPSortKeyW** in/out
Declare PtrSafe Function ldap_search_init_pageW Lib "wldap32" ( _
    ByVal ExternalHandle As LongPtr, _
    ByVal DistinguishedName As LongPtr, _
    ByVal ScopeOfSearch As Long, _
    ByVal SearchFilter As LongPtr, _
    ByVal AttributeList As LongPtr, _
    ByVal AttributesOnly As Long, _
    ByVal ServerControls As LongPtr, _
    ByVal ClientControls As LongPtr, _
    ByVal PageTimeLimit As Long, _
    ByVal TotalSizeLimit As Long, _
    ByVal SortKeys As LongPtr) As LongPtr
' 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_search_init_pageW = ctypes.cdll.wldap32.ldap_search_init_pageW
ldap_search_init_pageW.restype = ctypes.c_ssize_t
ldap_search_init_pageW.argtypes = [
    ctypes.c_void_p,  # ExternalHandle : LDAP* in/out
    wintypes.LPCWSTR,  # DistinguishedName : LPCWSTR
    wintypes.DWORD,  # ScopeOfSearch : DWORD
    wintypes.LPCWSTR,  # SearchFilter : LPCWSTR
    ctypes.c_void_p,  # AttributeList : WORD**
    wintypes.DWORD,  # AttributesOnly : DWORD
    ctypes.c_void_p,  # ServerControls : LDAPControlW** in/out
    ctypes.c_void_p,  # ClientControls : LDAPControlW** in/out
    wintypes.DWORD,  # PageTimeLimit : DWORD
    wintypes.DWORD,  # TotalSizeLimit : DWORD
    ctypes.c_void_p,  # SortKeys : LDAPSortKeyW** in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_search_init_pageW = Fiddle::Function.new(
  lib['ldap_search_init_pageW'],
  [
    Fiddle::TYPE_VOIDP,  # ExternalHandle : LDAP* in/out
    Fiddle::TYPE_VOIDP,  # DistinguishedName : LPCWSTR
    -Fiddle::TYPE_INT,  # ScopeOfSearch : DWORD
    Fiddle::TYPE_VOIDP,  # SearchFilter : LPCWSTR
    Fiddle::TYPE_VOIDP,  # AttributeList : WORD**
    -Fiddle::TYPE_INT,  # AttributesOnly : DWORD
    Fiddle::TYPE_VOIDP,  # ServerControls : LDAPControlW** in/out
    Fiddle::TYPE_VOIDP,  # ClientControls : LDAPControlW** in/out
    -Fiddle::TYPE_INT,  # PageTimeLimit : DWORD
    -Fiddle::TYPE_INT,  # TotalSizeLimit : DWORD
    Fiddle::TYPE_VOIDP,  # SortKeys : LDAPSortKeyW** in/out
  ],
  Fiddle::TYPE_INTPTR_T, Fiddle::Function::CDECL)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wldap32")]
extern "C" {
    fn ldap_search_init_pageW(
        ExternalHandle: *mut LDAP,  // LDAP* in/out
        DistinguishedName: *const u16,  // LPCWSTR
        ScopeOfSearch: u32,  // DWORD
        SearchFilter: *const u16,  // LPCWSTR
        AttributeList: *mut *mut u16,  // WORD**
        AttributesOnly: u32,  // DWORD
        ServerControls: *mut *mut LDAPControlW,  // LDAPControlW** in/out
        ClientControls: *mut *mut LDAPControlW,  // LDAPControlW** in/out
        PageTimeLimit: u32,  // DWORD
        TotalSizeLimit: u32,  // DWORD
        SortKeys: *mut *mut LDAPSortKeyW  // LDAPSortKeyW** in/out
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WLDAP32.dll", CharSet = CharSet.Unicode, SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr ldap_search_init_pageW(IntPtr ExternalHandle, [MarshalAs(UnmanagedType.LPWStr)] string DistinguishedName, uint ScopeOfSearch, [MarshalAs(UnmanagedType.LPWStr)] string SearchFilter, IntPtr AttributeList, uint AttributesOnly, IntPtr ServerControls, IntPtr ClientControls, uint PageTimeLimit, uint TotalSizeLimit, IntPtr SortKeys);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_search_init_pageW' -Namespace Win32 -PassThru
# $api::ldap_search_init_pageW(ExternalHandle, DistinguishedName, ScopeOfSearch, SearchFilter, AttributeList, AttributesOnly, ServerControls, ClientControls, PageTimeLimit, TotalSizeLimit, SortKeys)

#uselib "WLDAP32.dll"
#func global ldap_search_init_pageW "ldap_search_init_pageW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; ldap_search_init_pageW varptr(ExternalHandle), DistinguishedName, ScopeOfSearch, SearchFilter, varptr(AttributeList), AttributesOnly, varptr(ServerControls), varptr(ClientControls), PageTimeLimit, TotalSizeLimit, varptr(SortKeys)   ; 戻り値は stat
; ExternalHandle : LDAP* in/out -> "wptr"
; DistinguishedName : LPCWSTR -> "wptr"
; ScopeOfSearch : DWORD -> "wptr"
; SearchFilter : LPCWSTR -> "wptr"
; AttributeList : WORD** -> "wptr"
; AttributesOnly : DWORD -> "wptr"
; ServerControls : LDAPControlW** in/out -> "wptr"
; ClientControls : LDAPControlW** in/out -> "wptr"
; PageTimeLimit : DWORD -> "wptr"
; TotalSizeLimit : DWORD -> "wptr"
; SortKeys : LDAPSortKeyW** in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WLDAP32.dll"
#cfunc global ldap_search_init_pageW "ldap_search_init_pageW" var, wstr, int, wstr, var, int, var, var, int, int, var
; res = ldap_search_init_pageW(ExternalHandle, DistinguishedName, ScopeOfSearch, SearchFilter, AttributeList, AttributesOnly, ServerControls, ClientControls, PageTimeLimit, TotalSizeLimit, SortKeys)
; ExternalHandle : LDAP* in/out -> "var"
; DistinguishedName : LPCWSTR -> "wstr"
; ScopeOfSearch : DWORD -> "int"
; SearchFilter : LPCWSTR -> "wstr"
; AttributeList : WORD** -> "var"
; AttributesOnly : DWORD -> "int"
; ServerControls : LDAPControlW** in/out -> "var"
; ClientControls : LDAPControlW** in/out -> "var"
; PageTimeLimit : DWORD -> "int"
; TotalSizeLimit : DWORD -> "int"
; SortKeys : LDAPSortKeyW** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WLDAP32.dll"
#cfunc global ldap_search_init_pageW "ldap_search_init_pageW" sptr, wstr, int, wstr, sptr, int, sptr, sptr, int, int, sptr
; res = ldap_search_init_pageW(varptr(ExternalHandle), DistinguishedName, ScopeOfSearch, SearchFilter, varptr(AttributeList), AttributesOnly, varptr(ServerControls), varptr(ClientControls), PageTimeLimit, TotalSizeLimit, varptr(SortKeys))
; ExternalHandle : LDAP* in/out -> "sptr"
; DistinguishedName : LPCWSTR -> "wstr"
; ScopeOfSearch : DWORD -> "int"
; SearchFilter : LPCWSTR -> "wstr"
; AttributeList : WORD** -> "sptr"
; AttributesOnly : DWORD -> "int"
; ServerControls : LDAPControlW** in/out -> "sptr"
; ClientControls : LDAPControlW** in/out -> "sptr"
; PageTimeLimit : DWORD -> "int"
; TotalSizeLimit : DWORD -> "int"
; SortKeys : LDAPSortKeyW** in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; PLDAPSearch ldap_search_init_pageW(LDAP* ExternalHandle, LPCWSTR DistinguishedName, DWORD ScopeOfSearch, LPCWSTR SearchFilter, WORD** AttributeList, DWORD AttributesOnly, LDAPControlW** ServerControls, LDAPControlW** ClientControls, DWORD PageTimeLimit, DWORD TotalSizeLimit, LDAPSortKeyW** SortKeys)
#uselib "WLDAP32.dll"
#cfunc global ldap_search_init_pageW "ldap_search_init_pageW" var, wstr, int, wstr, var, int, var, var, int, int, var
; res = ldap_search_init_pageW(ExternalHandle, DistinguishedName, ScopeOfSearch, SearchFilter, AttributeList, AttributesOnly, ServerControls, ClientControls, PageTimeLimit, TotalSizeLimit, SortKeys)
; ExternalHandle : LDAP* in/out -> "var"
; DistinguishedName : LPCWSTR -> "wstr"
; ScopeOfSearch : DWORD -> "int"
; SearchFilter : LPCWSTR -> "wstr"
; AttributeList : WORD** -> "var"
; AttributesOnly : DWORD -> "int"
; ServerControls : LDAPControlW** in/out -> "var"
; ClientControls : LDAPControlW** in/out -> "var"
; PageTimeLimit : DWORD -> "int"
; TotalSizeLimit : DWORD -> "int"
; SortKeys : LDAPSortKeyW** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; PLDAPSearch ldap_search_init_pageW(LDAP* ExternalHandle, LPCWSTR DistinguishedName, DWORD ScopeOfSearch, LPCWSTR SearchFilter, WORD** AttributeList, DWORD AttributesOnly, LDAPControlW** ServerControls, LDAPControlW** ClientControls, DWORD PageTimeLimit, DWORD TotalSizeLimit, LDAPSortKeyW** SortKeys)
#uselib "WLDAP32.dll"
#cfunc global ldap_search_init_pageW "ldap_search_init_pageW" intptr, wstr, int, wstr, intptr, int, intptr, intptr, int, int, intptr
; res = ldap_search_init_pageW(varptr(ExternalHandle), DistinguishedName, ScopeOfSearch, SearchFilter, varptr(AttributeList), AttributesOnly, varptr(ServerControls), varptr(ClientControls), PageTimeLimit, TotalSizeLimit, varptr(SortKeys))
; ExternalHandle : LDAP* in/out -> "intptr"
; DistinguishedName : LPCWSTR -> "wstr"
; ScopeOfSearch : DWORD -> "int"
; SearchFilter : LPCWSTR -> "wstr"
; AttributeList : WORD** -> "intptr"
; AttributesOnly : DWORD -> "int"
; ServerControls : LDAPControlW** in/out -> "intptr"
; ClientControls : LDAPControlW** in/out -> "intptr"
; PageTimeLimit : DWORD -> "int"
; TotalSizeLimit : DWORD -> "int"
; SortKeys : LDAPSortKeyW** in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wldap32 = windows.NewLazySystemDLL("WLDAP32.dll")
	procldap_search_init_pageW = wldap32.NewProc("ldap_search_init_pageW")
)

// ExternalHandle (LDAP* in/out), DistinguishedName (LPCWSTR), ScopeOfSearch (DWORD), SearchFilter (LPCWSTR), AttributeList (WORD**), AttributesOnly (DWORD), ServerControls (LDAPControlW** in/out), ClientControls (LDAPControlW** in/out), PageTimeLimit (DWORD), TotalSizeLimit (DWORD), SortKeys (LDAPSortKeyW** in/out)
r1, _, err := procldap_search_init_pageW.Call(
	uintptr(ExternalHandle),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(DistinguishedName))),
	uintptr(ScopeOfSearch),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(SearchFilter))),
	uintptr(AttributeList),
	uintptr(AttributesOnly),
	uintptr(ServerControls),
	uintptr(ClientControls),
	uintptr(PageTimeLimit),
	uintptr(TotalSizeLimit),
	uintptr(SortKeys),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // PLDAPSearch

function ldap_search_init_pageW(
  ExternalHandle: Pointer;   // LDAP* in/out
  DistinguishedName: PWideChar;   // LPCWSTR
  ScopeOfSearch: DWORD;   // DWORD
  SearchFilter: PWideChar;   // LPCWSTR
  AttributeList: Pointer;   // WORD**
  AttributesOnly: DWORD;   // DWORD
  ServerControls: Pointer;   // LDAPControlW** in/out
  ClientControls: Pointer;   // LDAPControlW** in/out
  PageTimeLimit: DWORD;   // DWORD
  TotalSizeLimit: DWORD;   // DWORD
  SortKeys: Pointer   // LDAPSortKeyW** in/out
): NativeInt; cdecl;
  external 'WLDAP32.dll' name 'ldap_search_init_pageW';

result := DllCall("WLDAP32\ldap_search_init_pageW"
    , "Ptr", ExternalHandle   ; LDAP* in/out
    , "WStr", DistinguishedName   ; LPCWSTR
    , "UInt", ScopeOfSearch   ; DWORD
    , "WStr", SearchFilter   ; LPCWSTR
    , "Ptr", AttributeList   ; WORD**
    , "UInt", AttributesOnly   ; DWORD
    , "Ptr", ServerControls   ; LDAPControlW** in/out
    , "Ptr", ClientControls   ; LDAPControlW** in/out
    , "UInt", PageTimeLimit   ; DWORD
    , "UInt", TotalSizeLimit   ; DWORD
    , "Ptr", SortKeys   ; LDAPSortKeyW** in/out
    , "Cdecl Ptr")   ; return: PLDAPSearch

●ldap_search_init_pageW(ExternalHandle, DistinguishedName, ScopeOfSearch, SearchFilter, AttributeList, AttributesOnly, ServerControls, ClientControls, PageTimeLimit, TotalSizeLimit, SortKeys) = DLL("WLDAP32.dll", "int ldap_search_init_pageW(void*, char*, dword, char*, void*, dword, void*, void*, dword, dword, void*)")
# 呼び出し: ldap_search_init_pageW(ExternalHandle, DistinguishedName, ScopeOfSearch, SearchFilter, AttributeList, AttributesOnly, ServerControls, ClientControls, PageTimeLimit, TotalSizeLimit, SortKeys)
# ExternalHandle : LDAP* in/out -> "void*"
# DistinguishedName : LPCWSTR -> "char*"
# ScopeOfSearch : DWORD -> "dword"
# SearchFilter : LPCWSTR -> "char*"
# AttributeList : WORD** -> "void*"
# AttributesOnly : DWORD -> "dword"
# ServerControls : LDAPControlW** in/out -> "void*"
# ClientControls : LDAPControlW** in/out -> "void*"
# PageTimeLimit : DWORD -> "dword"
# TotalSizeLimit : DWORD -> "dword"
# SortKeys : LDAPSortKeyW** in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。