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

ldap_encode_sort_controlA

関数
ソートキーをLDAPソートコントロールにエンコードする(ANSI版)。
DLLWLDAP32.dll文字セットANSI (-A)呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

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

DWORD ldap_encode_sort_controlA(
    LDAP* ExternalHandle,
    LDAPSortKeyA** SortKeys,
    LDAPControlA* Control,
    BOOLEAN Criticality
);

パラメーター

名前方向説明
ExternalHandleLDAP*inout対象のLDAPセッションハンドル。コントロールを符号化する接続を指す。
SortKeysLDAPSortKeyA**inout符号化するソート条件のLDAPSortKeyA構造体NULL終端配列。並び替え属性を指定する。
ControlLDAPControlA*inout符号化結果を書き込む既存のLDAPControlA構造体。呼び出し側が用意する。
CriticalityBOOLEANin0以外ならこのコントロールを必須(クリティカル)として設定する真偽フラグ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ldap_encode_sort_controlA(
    LDAP* ExternalHandle,
    LDAPSortKeyA** SortKeys,
    LDAPControlA* Control,
    BOOLEAN Criticality
);
[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern uint ldap_encode_sort_controlA(
    IntPtr ExternalHandle,   // LDAP* in/out
    IntPtr SortKeys,   // LDAPSortKeyA** in/out
    IntPtr Control,   // LDAPControlA* in/out
    [MarshalAs(UnmanagedType.U1)] bool Criticality   // BOOLEAN
);
<DllImport("WLDAP32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_encode_sort_controlA(
    ExternalHandle As IntPtr,   ' LDAP* in/out
    SortKeys As IntPtr,   ' LDAPSortKeyA** in/out
    Control As IntPtr,   ' LDAPControlA* in/out
    <MarshalAs(UnmanagedType.U1)> Criticality As Boolean   ' BOOLEAN
) As UInteger
End Function
' ExternalHandle : LDAP* in/out
' SortKeys : LDAPSortKeyA** in/out
' Control : LDAPControlA* in/out
' Criticality : BOOLEAN
Declare PtrSafe Function ldap_encode_sort_controlA Lib "wldap32" ( _
    ByVal ExternalHandle As LongPtr, _
    ByVal SortKeys As LongPtr, _
    ByVal Control As LongPtr, _
    ByVal Criticality As Byte) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ldap_encode_sort_controlA = ctypes.cdll.wldap32.ldap_encode_sort_controlA
ldap_encode_sort_controlA.restype = wintypes.DWORD
ldap_encode_sort_controlA.argtypes = [
    ctypes.c_void_p,  # ExternalHandle : LDAP* in/out
    ctypes.c_void_p,  # SortKeys : LDAPSortKeyA** in/out
    ctypes.c_void_p,  # Control : LDAPControlA* in/out
    wintypes.BOOLEAN,  # Criticality : BOOLEAN
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_encode_sort_controlA = Fiddle::Function.new(
  lib['ldap_encode_sort_controlA'],
  [
    Fiddle::TYPE_VOIDP,  # ExternalHandle : LDAP* in/out
    Fiddle::TYPE_VOIDP,  # SortKeys : LDAPSortKeyA** in/out
    Fiddle::TYPE_VOIDP,  # Control : LDAPControlA* in/out
    Fiddle::TYPE_CHAR,  # Criticality : BOOLEAN
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)
#[link(name = "wldap32")]
extern "C" {
    fn ldap_encode_sort_controlA(
        ExternalHandle: *mut LDAP,  // LDAP* in/out
        SortKeys: *mut *mut LDAPSortKeyA,  // LDAPSortKeyA** in/out
        Control: *mut LDAPControlA,  // LDAPControlA* in/out
        Criticality: u8  // BOOLEAN
    ) -> 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_encode_sort_controlA(IntPtr ExternalHandle, IntPtr SortKeys, IntPtr Control, [MarshalAs(UnmanagedType.U1)] bool Criticality);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_encode_sort_controlA' -Namespace Win32 -PassThru
# $api::ldap_encode_sort_controlA(ExternalHandle, SortKeys, Control, Criticality)
#uselib "WLDAP32.dll"
#func global ldap_encode_sort_controlA "ldap_encode_sort_controlA" sptr, sptr, sptr, sptr
; ldap_encode_sort_controlA varptr(ExternalHandle), varptr(SortKeys), varptr(Control), Criticality   ; 戻り値は stat
; ExternalHandle : LDAP* in/out -> "sptr"
; SortKeys : LDAPSortKeyA** in/out -> "sptr"
; Control : LDAPControlA* in/out -> "sptr"
; Criticality : BOOLEAN -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WLDAP32.dll"
#cfunc global ldap_encode_sort_controlA "ldap_encode_sort_controlA" var, var, var, int
; res = ldap_encode_sort_controlA(ExternalHandle, SortKeys, Control, Criticality)
; ExternalHandle : LDAP* in/out -> "var"
; SortKeys : LDAPSortKeyA** in/out -> "var"
; Control : LDAPControlA* in/out -> "var"
; Criticality : BOOLEAN -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD ldap_encode_sort_controlA(LDAP* ExternalHandle, LDAPSortKeyA** SortKeys, LDAPControlA* Control, BOOLEAN Criticality)
#uselib "WLDAP32.dll"
#cfunc global ldap_encode_sort_controlA "ldap_encode_sort_controlA" var, var, var, int
; res = ldap_encode_sort_controlA(ExternalHandle, SortKeys, Control, Criticality)
; ExternalHandle : LDAP* in/out -> "var"
; SortKeys : LDAPSortKeyA** in/out -> "var"
; Control : LDAPControlA* in/out -> "var"
; Criticality : BOOLEAN -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wldap32 = windows.NewLazySystemDLL("WLDAP32.dll")
	procldap_encode_sort_controlA = wldap32.NewProc("ldap_encode_sort_controlA")
)

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

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

typedef ldap_encode_sort_controlANative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Uint8);
typedef ldap_encode_sort_controlADart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int);
final ldap_encode_sort_controlA = DynamicLibrary.open('WLDAP32.dll')
    .lookupFunction<ldap_encode_sort_controlANative, ldap_encode_sort_controlADart>('ldap_encode_sort_controlA');
// ExternalHandle : LDAP* in/out -> Pointer<Void>
// SortKeys : LDAPSortKeyA** in/out -> Pointer<Void>
// Control : LDAPControlA* in/out -> Pointer<Void>
// Criticality : BOOLEAN -> Uint8
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ldap_encode_sort_controlA(
  ExternalHandle: Pointer;   // LDAP* in/out
  SortKeys: Pointer;   // LDAPSortKeyA** in/out
  Control: Pointer;   // LDAPControlA* in/out
  Criticality: ByteBool   // BOOLEAN
): DWORD; cdecl;
  external 'WLDAP32.dll' name 'ldap_encode_sort_controlA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "ldap_encode_sort_controlA"
  c_ldap_encode_sort_controlA :: Ptr () -> Ptr () -> Ptr () -> Word8 -> IO Word32
-- ExternalHandle : LDAP* in/out -> Ptr ()
-- SortKeys : LDAPSortKeyA** in/out -> Ptr ()
-- Control : LDAPControlA* in/out -> Ptr ()
-- Criticality : BOOLEAN -> Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ldap_encode_sort_controla =
  foreign "ldap_encode_sort_controlA"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> uint8_t @-> returning uint32_t)
(* ExternalHandle : LDAP* in/out -> (ptr void) *)
(* SortKeys : LDAPSortKeyA** in/out -> (ptr void) *)
(* Control : LDAPControlA* in/out -> (ptr void) *)
(* Criticality : BOOLEAN -> uint8_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wldap32 (t "WLDAP32.dll"))
(cffi:use-foreign-library wldap32)

(cffi:defcfun ("ldap_encode_sort_controlA" ldap-encode-sort-control-a :convention :cdecl) :uint32
  (external-handle :pointer)   ; LDAP* in/out
  (sort-keys :pointer)   ; LDAPSortKeyA** in/out
  (control :pointer)   ; LDAPControlA* in/out
  (criticality :uint8))   ; BOOLEAN
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ldap_encode_sort_controlA = Win32::API::More->new('WLDAP32',
    'DWORD ldap_encode_sort_controlA(LPVOID ExternalHandle, LPVOID SortKeys, LPVOID Control, BYTE Criticality)');
# my $ret = $ldap_encode_sort_controlA->Call($ExternalHandle, $SortKeys, $Control, $Criticality);
# ExternalHandle : LDAP* in/out -> LPVOID
# SortKeys : LDAPSortKeyA** in/out -> LPVOID
# Control : LDAPControlA* in/out -> LPVOID
# Criticality : BOOLEAN -> BYTE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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