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

LDAPControlW

構造体
サイズx64: 32 バイト / x86: 16 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
ldctl_oidLPWSTR8/4+0+0"1.2.840.113556.1.4.805" のような、コントロールの種類を示すワイド文字の NULL 終端文字列へのポインター。
ldctl_valueLDAP_BERVAL16/8+8+4コントロールに関連付けられたデータ (存在する場合)。コントロールにデータが関連付けられていない場合は、このメンバーを NULL に設定します。
ldctl_iscriticalBOOLEAN1+24+12コントロールがクリティカル (critical) かどうかを示します。Criticality フィールドと呼ばれます。

公式ドキュメント

LDAPControl 構造体は、クライアント側コントロールとサーバー コントロールの両方を表します。

解説(Remarks)

LDAP 3 以降では、コントロールを使用して LDAP 操作を拡張できます。サーバー コントロールは、任意の LDAP メッセージと共にサーバーへ送信したり、クライアントへ返したりできます。クライアント コントロールはクライアント側でのみ LDAP API の動作を拡張し、サーバーに送信されることはありません。サポートされているコントロールは、ディレクトリ サービスのルートにオブジェクト識別子 (OID) として格納されます。

ldctl_iscritical メンバーを使用すると、サーバーまたはクライアントがコントロールをサポートしていない場合でも、拡張操作を成功させることができます。このフィールドの値が 0 の場合、サーバーまたはクライアント (あるいはその両方) は、サポートしていないコントロールを無視して操作を実行します。値が 0 以外の場合、操作はサーバーまたはクライアント (あるいはその両方) がコントロールを認識した場合にのみ実行されます。

詳細情報と、サポートされている LDAP 拡張コントロールの一覧および説明については、

Extended Controls を参照してください。

メモ

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

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

各言語での定義

#include <windows.h>

// LDAP_BERVAL  (x64 16 / x86 8 バイト)
typedef struct LDAP_BERVAL {
    DWORD bv_len;
    LPSTR bv_val;
} LDAP_BERVAL;

// LDAPControlW  (x64 32 / x86 16 バイト)
typedef struct LDAPControlW {
    LPWSTR ldctl_oid;
    LDAP_BERVAL ldctl_value;
    BOOLEAN ldctl_iscritical;
} LDAPControlW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct LDAP_BERVAL
{
    public uint bv_len;
    public IntPtr bv_val;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct LDAPControlW
{
    public IntPtr ldctl_oid;
    public LDAP_BERVAL ldctl_value;
    [MarshalAs(UnmanagedType.U1)] public bool ldctl_iscritical;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure LDAP_BERVAL
    Public bv_len As UInteger
    Public bv_val As IntPtr
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure LDAPControlW
    Public ldctl_oid As IntPtr
    Public ldctl_value As LDAP_BERVAL
    <MarshalAs(UnmanagedType.U1)> Public ldctl_iscritical As Boolean
End Structure
import ctypes
from ctypes import wintypes

class LDAP_BERVAL(ctypes.Structure):
    _fields_ = [
        ("bv_len", wintypes.DWORD),
        ("bv_val", ctypes.c_void_p),
    ]

class LDAPControlW(ctypes.Structure):
    _fields_ = [
        ("ldctl_oid", ctypes.c_void_p),
        ("ldctl_value", LDAP_BERVAL),
        ("ldctl_iscritical", ctypes.c_byte),
    ]
#[repr(C)]
pub struct LDAP_BERVAL {
    pub bv_len: u32,
    pub bv_val: *mut core::ffi::c_void,
}

#[repr(C)]
pub struct LDAPControlW {
    pub ldctl_oid: *mut core::ffi::c_void,
    pub ldctl_value: LDAP_BERVAL,
    pub ldctl_iscritical: u8,
}
import "golang.org/x/sys/windows"

type LDAP_BERVAL struct {
	bv_len uint32
	bv_val uintptr
}

type LDAPControlW struct {
	ldctl_oid uintptr
	ldctl_value LDAP_BERVAL
	ldctl_iscritical byte
}
type
  LDAP_BERVAL = record
    bv_len: DWORD;
    bv_val: Pointer;
  end;

  LDAPControlW = record
    ldctl_oid: Pointer;
    ldctl_value: LDAP_BERVAL;
    ldctl_iscritical: ByteBool;
  end;
const LDAP_BERVAL = extern struct {
    bv_len: u32,
    bv_val: ?*anyopaque,
};

const LDAPControlW = extern struct {
    ldctl_oid: ?*anyopaque,
    ldctl_value: LDAP_BERVAL,
    ldctl_iscritical: u8,
};
type
  LDAP_BERVAL {.bycopy.} = object
    bv_len: uint32
    bv_val: pointer

  LDAPControlW {.bycopy.} = object
    ldctl_oid: pointer
    ldctl_value: LDAP_BERVAL
    ldctl_iscritical: uint8
struct LDAP_BERVAL
{
    uint bv_len;
    void* bv_val;
}

struct LDAPControlW
{
    void* ldctl_oid;
    LDAP_BERVAL ldctl_value;
    ubyte ldctl_iscritical;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; LDAPControlW サイズ: 16 バイト(x86)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; ldctl_oid : LPWSTR (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; ldctl_value : LDAP_BERVAL (+4, 8byte)  varptr(st)+4 を基点に操作(8byte:入れ子/配列)
; ldctl_iscritical : BOOLEAN (+12, 1byte)  poke st,12,値  /  値 = peek(st,12)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; LDAPControlW サイズ: 32 バイト(x64)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; ldctl_oid : LPWSTR (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; ldctl_value : LDAP_BERVAL (+8, 16byte)  varptr(st)+8 を基点に操作(16byte:入れ子/配列)
; ldctl_iscritical : BOOLEAN (+24, 1byte)  poke st,24,値  /  値 = peek(st,24)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global LDAP_BERVAL
    #field int bv_len
    #field intptr bv_val
#endstruct

#defstruct global LDAPControlW
    #field intptr ldctl_oid
    #field LDAP_BERVAL ldctl_value
    #field bool1 ldctl_iscritical
#endstruct

stdim st, LDAPControlW        ; NSTRUCT 変数を確保
st->ldctl_iscritical = 100
mes "ldctl_iscritical=" + st->ldctl_iscritical