ber_scanf

関数可変長引数

書式指定に従ってBER形式のデータをデコードする。

DLLWLDAP32.dll呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

// WLDAP32.dll
#include <windows.h>

DWORD ber_scanf(
    BerElement* pBerElement,
    LPSTR fmt,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

パラメーター

名前	型	方向	説明
pBerElement	BerElement*	inout	デコードされた BerElement 構造体へのポインター。
fmt	LPSTR	in	エンコード形式を指定する書式文字列。詳細については、「解説」セクションを参照してください。

戻り値の型: DWORD

公式ドキュメント

ber_scanf 関数は、sscanf_s と同様の方法で BER 要素をデコードします。

戻り値

エラーが発生した場合、この関数は LBER_ERROR を返します。

解説(Remarks)

この関数は、書式文字列 fmt に従ってバイト列を解釈し、その結果を追加の引数に格納します。書式文字列には、BER 要素の解釈方法を指示する変換指定が含まれます。書式文字列には、次の表に示す文字を指定できます。

文字	説明
a	オクテット文字列。char** 引数を指定する必要があります。メモリが割り当てられ、オクテット文字列の内容が格納されてゼロ終端され、その文字列へのポインターが引数に格納されます。返された値は ldap_memfree を使用して解放してください。要素のタグは基本形 (primitive form) を示す必要があります (構成形 (constructed) の文字列はサポートされません) が、それ以外はデコード時に無視され、破棄されます。この形式は、null バイトを含む可能性のあるオクテット文字列には使用できません。
O	オクテット文字列。berval 引数を指定する必要があります。この引数は、関数から制御が戻ったときに、オクテット文字列とその長さを格納する、割り当て済みの berval** を指します。割り当てられたメモリを解放するには ber_bvfree を呼び出す必要があります。要素のタグは基本形を示す必要があります (構成形の文字列はサポートされません) が、それ以外はデコード時に無視されます。
b	ブール値。ber_int_t へのポインターを指定する必要があります。格納される ber_int_t の値は、FALSE の場合は 0、TRUE の場合は 0 以外になります。要素のタグは基本形を示す必要がありますが、それ以外はデコード時に無視されます。
e	列挙型。ber_int_t へのポインターを指定する必要があります。要素のタグは基本形を示す必要がありますが、それ以外はデコード時に無視されます。列挙値を ber_int_t に格納できない場合、ber_scanf はエラーを返します。
i	整数。ber_int_t へのポインターを指定する必要があります。要素のタグは基本形を示す必要がありますが、それ以外はデコード時に無視されます。整数を ber_int_t に格納できない場合、ber_scanf はエラーを返します。
B	ビット文字列。割り当てられたビット列を指す char 引数を指定し、続いて、返されるビット文字列の長さ (ビット単位) を指す ber_len_t** * 引数を指定する必要があります。ビット文字列を解放するには ldap_memfree を呼び出す必要があります。要素のタグは基本形を示す必要があります (構成形のビット文字列はサポートされません) が、それ以外はデコード時に無視されます。
n	Null。引数は不要です。要素の値の長さが 0 であることが検証され、その要素はスキップされます。タグは無視されます。
t	タグ。ber_tag_t へのポインターを指定する必要があります。格納される ber_tag_t の値は pBerElement 内の次の要素のタグであり、ber_printf の t 形式で書き込めるように表現されます。これによって pBerElement 引数内のデコード位置は変化しません。
v	複数のオクテット文字列。char*** 引数を指定する必要があります。この引数は、関数から制御が戻ったときに、オクテット文字列を格納する char * の NULL 終端配列 (割り当て済み) を指します。シーケンスが空の場合は NULL が格納されます。配列の各要素と配列自体を解放するには ldap_memfree を呼び出す必要があります。シーケンスおよびオクテット文字列のタグは無視されます。
V	複数のオクテット文字列 (null バイトを含む可能性があります)。berval*** を指定する必要があります。この引数は、関数から制御が戻ったときに、オクテット文字列とその長さを格納する berval* の NULL 終端配列 (割り当て済み) を指します。シーケンスが空の場合は NULL が格納されます。割り当てられたメモリを解放するには ber_bvecfree を呼び出すことができます。シーケンスおよびオクテット文字列のタグは無視されます。
x	要素のスキップ。次の要素がスキップされます。引数は不要です。
{	シーケンスの開始。引数は不要です。先頭のシーケンスのタグと長さがスキップされます。
}	シーケンスの終了。引数は不要です。
[	セットの開始。引数は不要です。先頭のセットのタグと長さがスキップされます。
]	セットの終了。引数は不要です。

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

各言語での呼び出し定義

// WLDAP32.dll
#include <windows.h>

DWORD ber_scanf(
    BerElement* pBerElement,
    LPSTR fmt,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

[DllImport("WLDAP32.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern uint ber_scanf(
    IntPtr pBerElement,   // BerElement* in/out
    [MarshalAs(UnmanagedType.LPStr)] string fmt,   // LPSTR
    __arglist
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

<DllImport("WLDAP32.dll", ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ber_scanf(
    pBerElement As IntPtr,   ' BerElement* in/out
    <MarshalAs(UnmanagedType.LPStr)> fmt As String   ' LPSTR
) As UInteger
End Function
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

' pBerElement : BerElement* in/out
' fmt : LPSTR
Declare PtrSafe Function ber_scanf Lib "wldap32" ( _
    ByVal pBerElement As LongPtr, _
    ByVal fmt As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

import ctypes
from ctypes import wintypes

ber_scanf = ctypes.cdll.wldap32.ber_scanf
ber_scanf.restype = wintypes.DWORD
ber_scanf.argtypes = [
    ctypes.c_void_p,  # pBerElement : BerElement* in/out
    wintypes.LPCSTR,  # fmt : LPSTR
]
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ber_scanf = Fiddle::Function.new(
  lib['ber_scanf'],
  [
    Fiddle::TYPE_VOIDP,  # pBerElement : BerElement* in/out
    Fiddle::TYPE_VOIDP,  # fmt : LPSTR
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

#[link(name = "wldap32")]
extern "C" {
    fn ber_scanf(
        pBerElement: *mut BerElement,  // BerElement* in/out
        fmt: *mut u8,  // LPSTR
        ...
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

$sig = @"
[DllImport("WLDAP32.dll", CallingConvention = CallingConvention.Cdecl)]
public static extern uint ber_scanf(IntPtr pBerElement, [MarshalAs(UnmanagedType.LPStr)] string fmt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ber_scanf' -Namespace Win32 -PassThru
# $api::ber_scanf(pBerElement, fmt)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

#uselib "WLDAP32.dll"
#func global ber_scanf "ber_scanf" sptr, sptr
; ber_scanf varptr(pBerElement), fmt   ; 戻り値は stat
; pBerElement : BerElement* in/out -> "sptr"
; fmt : LPSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

出力引数:

#uselib "WLDAP32.dll"
#cfunc global ber_scanf "ber_scanf" var, str
; res = ber_scanf(pBerElement, fmt)
; pBerElement : BerElement* in/out -> "var"
; fmt : LPSTR -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。#uselib "WLDAP32.dll"
#cfunc global ber_scanf "ber_scanf" sptr, str
; res = ber_scanf(varptr(pBerElement), fmt)
; pBerElement : BerElement* in/out -> "sptr"
; fmt : LPSTR -> "str"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。