ホーム › Networking.Ldap › ldap_escape_filter_elementW

ldap_escape_filter_elementW

関数

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

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
sourceFilterElement	LPSTR	in	変換するフィルター要素を格納した null 終端文字列へのポインター。
sourceLength	DWORD	in	変換元のフィルター要素の長さ (バイト単位)。
destFilterElement	LPWSTR	outoptional	null 終端文字列へのポインター。
destLength	DWORD	in	destFilterElement バッファーの長さ (バイト単位)。

戻り値の型: DWORD

公式ドキュメント

ldap_escape_filter_elementW (Unicode) 関数 (winldap.h) は、フィルター要素を、検索フィルター内で安全に渡すことができる null 終端文字列に変換します。

戻り値

関数が成功した場合、戻り値は LDAP_SUCCESS です。

関数が失敗した場合は、エラーコードを返します。詳細については、 Return Values を参照してください。

解説(Remarks)

ldap_escape_filter_element 関数を使用すると、検索フィルターで生のバイナリデータを使用できます。たとえば、この関数を使用して、照合する属性として証明書や JPEG 画像を指定できます。

sourceFilterElement パラメーターに生データを指すポインターを設定し、sourceLength にそのデータの長さを適切に設定して ldap_escape_filter_element を呼び出します。destFilterElement パラメーターが NULL の場合、戻り値は出力バッファーに必要な長さになります。destFilterElement が NULL でない場合、この関数は変換元を出力先バッファーにコピーし、安全な形式になるようにします。その後、出力先バッファーの内容を検索フィルター内の "attributetype=" フィルター要素の後ろに挿入します。

メモ文字列である属性値に対して ldap_escape_filter_element を呼び出さないでください。ランタイムは UTF-8 形式からの変換を一切行いません。この関数は、生のバイナリデータである属性要素に対してのみ使用してください。

メモ

winldap.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ldap_escape_filter_element を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

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

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

' sourceFilterElement : LPSTR
' sourceLength : DWORD
' destFilterElement : LPWSTR optional, out
' destLength : DWORD
Declare PtrSafe Function ldap_escape_filter_elementW Lib "wldap32" ( _
    ByVal sourceFilterElement As String, _
    ByVal sourceLength As Long, _
    ByVal destFilterElement As LongPtr, _
    ByVal destLength As Long) 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_escape_filter_elementW = ctypes.cdll.wldap32.ldap_escape_filter_elementW
ldap_escape_filter_elementW.restype = wintypes.DWORD
ldap_escape_filter_elementW.argtypes = [
    wintypes.LPCSTR,  # sourceFilterElement : LPSTR
    wintypes.DWORD,  # sourceLength : DWORD
    wintypes.LPWSTR,  # destFilterElement : LPWSTR optional, out
    wintypes.DWORD,  # destLength : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_escape_filter_elementW = Fiddle::Function.new(
  lib['ldap_escape_filter_elementW'],
  [
    Fiddle::TYPE_VOIDP,  # sourceFilterElement : LPSTR
    -Fiddle::TYPE_INT,  # sourceLength : DWORD
    Fiddle::TYPE_VOIDP,  # destFilterElement : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # destLength : DWORD
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

出力引数:

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