ホーム › Networking.Ldap › ldap_escape_filter_elementA

ldap_escape_filter_elementA

関数

検索フィルタ要素を安全な形にエスケープする(ANSI版)。

DLLWLDAP32.dll文字セットANSI (-A)呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

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

DWORD ldap_escape_filter_elementA(
    LPSTR sourceFilterElement,
    DWORD sourceLength,
    LPSTR destFilterElement,   // optional
    DWORD destLength
);

パラメーター

名前	型	方向	説明
sourceFilterElement	LPSTR	in	エスケープ対象の入力バイト列。検索フィルタに埋め込む生の要素。
sourceLength	DWORD	in	sourceFilterElementのバイト長。処理する入力サイズを指定する。
destFilterElement	LPSTR	outoptional	エスケープ済み文字列を受け取る出力バッファ(ANSI)。NULLで必要長を取得可。
destLength	DWORD	in	destFilterElementバッファのサイズ(バイト数)。出力可能な最大長を指定する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ldap_escape_filter_elementA(
    LPSTR sourceFilterElement,
    DWORD sourceLength,
    LPSTR destFilterElement,   // optional
    DWORD destLength
);

[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern uint ldap_escape_filter_elementA(
    [MarshalAs(UnmanagedType.LPStr)] string sourceFilterElement,   // LPSTR
    uint sourceLength,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder destFilterElement,   // LPSTR optional, out
    uint destLength   // DWORD
);

<DllImport("WLDAP32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_escape_filter_elementA(
    <MarshalAs(UnmanagedType.LPStr)> sourceFilterElement As String,   ' LPSTR
    sourceLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> destFilterElement As System.Text.StringBuilder,   ' LPSTR optional, out
    destLength As UInteger   ' DWORD
) As UInteger
End Function

' sourceFilterElement : LPSTR
' sourceLength : DWORD
' destFilterElement : LPSTR optional, out
' destLength : DWORD
Declare PtrSafe Function ldap_escape_filter_elementA Lib "wldap32" ( _
    ByVal sourceFilterElement As String, _
    ByVal sourceLength As Long, _
    ByVal destFilterElement As String, _
    ByVal destLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ldap_escape_filter_elementA = ctypes.cdll.wldap32.ldap_escape_filter_elementA
ldap_escape_filter_elementA.restype = wintypes.DWORD
ldap_escape_filter_elementA.argtypes = [
    wintypes.LPCSTR,  # sourceFilterElement : LPSTR
    wintypes.DWORD,  # sourceLength : DWORD
    wintypes.LPSTR,  # destFilterElement : LPSTR optional, out
    wintypes.DWORD,  # destLength : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_escape_filter_elementA = Fiddle::Function.new(
  lib['ldap_escape_filter_elementA'],
  [
    Fiddle::TYPE_VOIDP,  # sourceFilterElement : LPSTR
    -Fiddle::TYPE_INT,  # sourceLength : DWORD
    Fiddle::TYPE_VOIDP,  # destFilterElement : LPSTR optional, out
    -Fiddle::TYPE_INT,  # destLength : DWORD
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)

#[link(name = "wldap32")]
extern "C" {
    fn ldap_escape_filter_elementA(
        sourceFilterElement: *mut u8,  // LPSTR
        sourceLength: u32,  // DWORD
        destFilterElement: *mut u8,  // LPSTR optional, out
        destLength: u32  // DWORD
    ) -> 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_escape_filter_elementA([MarshalAs(UnmanagedType.LPStr)] string sourceFilterElement, uint sourceLength, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder destFilterElement, uint destLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_escape_filter_elementA' -Namespace Win32 -PassThru
# $api::ldap_escape_filter_elementA(sourceFilterElement, sourceLength, destFilterElement, destLength)

#uselib "WLDAP32.dll"
#func global ldap_escape_filter_elementA "ldap_escape_filter_elementA" sptr, sptr, sptr, sptr
; ldap_escape_filter_elementA sourceFilterElement, sourceLength, varptr(destFilterElement), destLength   ; 戻り値は stat
; sourceFilterElement : LPSTR -> "sptr"
; sourceLength : DWORD -> "sptr"
; destFilterElement : LPSTR optional, out -> "sptr"
; destLength : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WLDAP32.dll"
#cfunc global ldap_escape_filter_elementA "ldap_escape_filter_elementA" str, int, var, int
; res = ldap_escape_filter_elementA(sourceFilterElement, sourceLength, destFilterElement, destLength)
; sourceFilterElement : LPSTR -> "str"
; sourceLength : DWORD -> "int"
; destFilterElement : LPSTR optional, out -> "var"
; destLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WLDAP32.dll"
#cfunc global ldap_escape_filter_elementA "ldap_escape_filter_elementA" str, int, sptr, int
; res = ldap_escape_filter_elementA(sourceFilterElement, sourceLength, varptr(destFilterElement), destLength)
; sourceFilterElement : LPSTR -> "str"
; sourceLength : DWORD -> "int"
; destFilterElement : LPSTR optional, out -> "sptr"
; destLength : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD ldap_escape_filter_elementA(LPSTR sourceFilterElement, DWORD sourceLength, LPSTR destFilterElement, DWORD destLength)
#uselib "WLDAP32.dll"
#cfunc global ldap_escape_filter_elementA "ldap_escape_filter_elementA" str, int, var, int
; res = ldap_escape_filter_elementA(sourceFilterElement, sourceLength, destFilterElement, destLength)
; sourceFilterElement : LPSTR -> "str"
; sourceLength : DWORD -> "int"
; destFilterElement : LPSTR optional, out -> "var"
; destLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD ldap_escape_filter_elementA(LPSTR sourceFilterElement, DWORD sourceLength, LPSTR destFilterElement, DWORD destLength)
#uselib "WLDAP32.dll"
#cfunc global ldap_escape_filter_elementA "ldap_escape_filter_elementA" str, int, intptr, int
; res = ldap_escape_filter_elementA(sourceFilterElement, sourceLength, varptr(destFilterElement), destLength)
; sourceFilterElement : LPSTR -> "str"
; sourceLength : DWORD -> "int"
; destFilterElement : LPSTR optional, out -> "intptr"
; destLength : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	wldap32 = windows.NewLazySystemDLL("WLDAP32.dll")
	procldap_escape_filter_elementA = wldap32.NewProc("ldap_escape_filter_elementA")
)

// sourceFilterElement (LPSTR), sourceLength (DWORD), destFilterElement (LPSTR optional, out), destLength (DWORD)
r1, _, err := procldap_escape_filter_elementA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(sourceFilterElement))),
	uintptr(sourceLength),
	uintptr(destFilterElement),
	uintptr(destLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function ldap_escape_filter_elementA(
  sourceFilterElement: PAnsiChar;   // LPSTR
  sourceLength: DWORD;   // DWORD
  destFilterElement: PAnsiChar;   // LPSTR optional, out
  destLength: DWORD   // DWORD
): DWORD; cdecl;
  external 'WLDAP32.dll' name 'ldap_escape_filter_elementA';

result := DllCall("WLDAP32\ldap_escape_filter_elementA"
    , "AStr", sourceFilterElement   ; LPSTR
    , "UInt", sourceLength   ; DWORD
    , "Ptr", destFilterElement   ; LPSTR optional, out
    , "UInt", destLength   ; DWORD
    , "Cdecl UInt")   ; return: DWORD

●ldap_escape_filter_elementA(sourceFilterElement, sourceLength, destFilterElement, destLength) = DLL("WLDAP32.dll", "dword ldap_escape_filter_elementA(char*, dword, char*, dword)")
# 呼び出し: ldap_escape_filter_elementA(sourceFilterElement, sourceLength, destFilterElement, destLength)
# sourceFilterElement : LPSTR -> "char*"
# sourceLength : DWORD -> "dword"
# destFilterElement : LPSTR optional, out -> "char*"
# destLength : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。

const std = @import("std");

extern "wldap32" fn ldap_escape_filter_elementA(
    sourceFilterElement: [*c]const u8, // LPSTR
    sourceLength: u32, // DWORD
    destFilterElement: [*c]u8, // LPSTR optional, out
    destLength: u32 // DWORD
) callconv(.c) u32;

proc ldap_escape_filter_elementA(
    sourceFilterElement: cstring,  # LPSTR
    sourceLength: uint32,  # DWORD
    destFilterElement: ptr char,  # LPSTR optional, out
    destLength: uint32  # DWORD
): uint32 {.importc: "ldap_escape_filter_elementA", cdecl, dynlib: "WLDAP32.dll".}

pragma(lib, "wldap32");
extern(C)
uint ldap_escape_filter_elementA(
    const(char)* sourceFilterElement,   // LPSTR
    uint sourceLength,   // DWORD
    char* destFilterElement,   // LPSTR optional, out
    uint destLength   // DWORD
);

ccall((:ldap_escape_filter_elementA, "WLDAP32.dll"), UInt32,
      (Cstring, UInt32, Ptr{UInt8}, UInt32),
      sourceFilterElement, sourceLength, destFilterElement, destLength)
# sourceFilterElement : LPSTR -> Cstring
# sourceLength : DWORD -> UInt32
# destFilterElement : LPSTR optional, out -> Ptr{UInt8}
# destLength : DWORD -> UInt32

local ffi = require("ffi")
ffi.cdef[[
uint32_t ldap_escape_filter_elementA(
    const char* sourceFilterElement,
    uint32_t sourceLength,
    char* destFilterElement,
    uint32_t destLength);
]]
local wldap32 = ffi.load("wldap32")
-- wldap32.ldap_escape_filter_elementA(sourceFilterElement, sourceLength, destFilterElement, destLength)
-- sourceFilterElement : LPSTR
-- sourceLength : DWORD
-- destFilterElement : LPSTR optional, out
-- destLength : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('WLDAP32.dll');
const ldap_escape_filter_elementA = lib.func('__cdecl', 'ldap_escape_filter_elementA', 'uint32_t', ['str', 'uint32_t', 'char *', 'uint32_t']);
// ldap_escape_filter_elementA(sourceFilterElement, sourceLength, destFilterElement, destLength)
// sourceFilterElement : LPSTR -> 'str'
// sourceLength : DWORD -> 'uint32_t'
// destFilterElement : LPSTR optional, out -> 'char *'
// destLength : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("WLDAP32.dll", {
  ldap_escape_filter_elementA: { parameters: ["buffer", "u32", "buffer", "u32"], result: "u32" },
});
// lib.symbols.ldap_escape_filter_elementA(sourceFilterElement, sourceLength, destFilterElement, destLength)
// sourceFilterElement : LPSTR -> "buffer"
// sourceLength : DWORD -> "u32"
// destFilterElement : LPSTR optional, out -> "buffer"
// destLength : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t ldap_escape_filter_elementA(
    const char* sourceFilterElement,
    uint32_t sourceLength,
    char* destFilterElement,
    uint32_t destLength);
C, "WLDAP32.dll");
// $ffi->ldap_escape_filter_elementA(sourceFilterElement, sourceLength, destFilterElement, destLength);
// sourceFilterElement : LPSTR
// sourceLength : DWORD
// destFilterElement : LPSTR optional, out
// destLength : DWORD
// 構造体/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_escape_filter_elementA(
        String sourceFilterElement,   // LPSTR
        int sourceLength,   // DWORD
        byte[] destFilterElement,   // LPSTR optional, out
        int destLength   // DWORD
    );
}

@[Link("wldap32")]
lib LibWLDAP32
  fun ldap_escape_filter_elementA = ldap_escape_filter_elementA(
    sourceFilterElement : UInt8*,   # LPSTR
    sourceLength : UInt32,   # DWORD
    destFilterElement : UInt8*,   # LPSTR optional, out
    destLength : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ldap_escape_filter_elementANative = Uint32 Function(Pointer<Utf8>, Uint32, Pointer<Utf8>, Uint32);
typedef ldap_escape_filter_elementADart = int Function(Pointer<Utf8>, int, Pointer<Utf8>, int);
final ldap_escape_filter_elementA = DynamicLibrary.open('WLDAP32.dll')
    .lookupFunction<ldap_escape_filter_elementANative, ldap_escape_filter_elementADart>('ldap_escape_filter_elementA');
// sourceFilterElement : LPSTR -> Pointer<Utf8>
// sourceLength : DWORD -> Uint32
// destFilterElement : LPSTR optional, out -> Pointer<Utf8>
// destLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function ldap_escape_filter_elementA(
  sourceFilterElement: PAnsiChar;   // LPSTR
  sourceLength: DWORD;   // DWORD
  destFilterElement: PAnsiChar;   // LPSTR optional, out
  destLength: DWORD   // DWORD
): DWORD; cdecl;
  external 'WLDAP32.dll' name 'ldap_escape_filter_elementA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "ldap_escape_filter_elementA"
  c_ldap_escape_filter_elementA :: CString -> Word32 -> CString -> Word32 -> IO Word32
-- sourceFilterElement : LPSTR -> CString
-- sourceLength : DWORD -> Word32
-- destFilterElement : LPSTR optional, out -> CString
-- destLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let ldap_escape_filter_elementa =
  foreign "ldap_escape_filter_elementA"
    (string @-> uint32_t @-> string @-> uint32_t @-> returning uint32_t)
(* sourceFilterElement : LPSTR -> string *)
(* sourceLength : DWORD -> uint32_t *)
(* destFilterElement : LPSTR optional, out -> string *)
(* destLength : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library wldap32 (t "WLDAP32.dll"))
(cffi:use-foreign-library wldap32)

(cffi:defcfun ("ldap_escape_filter_elementA" ldap-escape-filter-element-a :convention :cdecl) :uint32
  (source-filter-element :string)   ; LPSTR
  (source-length :uint32)   ; DWORD
  (dest-filter-element :pointer)   ; LPSTR optional, out
  (dest-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $ldap_escape_filter_elementA = Win32::API::More->new('WLDAP32',
    'DWORD ldap_escape_filter_elementA(LPCSTR sourceFilterElement, DWORD sourceLength, LPSTR destFilterElement, DWORD destLength)');
# my $ret = $ldap_escape_filter_elementA->Call($sourceFilterElement, $sourceLength, $destFilterElement, $destLength);
# sourceFilterElement : LPSTR -> LPCSTR
# sourceLength : DWORD -> DWORD
# destFilterElement : LPSTR optional, out -> LPSTR
# destLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

ldap_escape_filter_elementA

シグネチャ

パラメーター

各言語での呼び出し定義

関連項目