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

LDAPSortKeyW

構造体
サイズx64: 24 バイト / x86: 12 バイト

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

フィールド

フィールドサイズx64x86説明
sk_attrtypeLPWSTR8/4+0+0ソート キーとして使用する属性の名前を指定する、null で終わる文字列へのポインターです。複数のソート キーを指定するには、複数の LDAPSortKey 構造体を使用します。Active Directory は単一のソート キーのみをサポートしている点に注意してください。
sk_matchruleoidLPWSTR8/4+8+4ソートに使用する一致規則のオブジェクト識別子を指定する、null で終わる文字列へのポインターです。ソートの一致規則を明示的に指定しない場合は NULL に設定してください。一致規則の明示的な指定は Windows Server 2003 でのみサポートされています。
sk_reverseorderBOOLEAN1+16+8TRUE の場合、小さい値から大きい値の順にソートすることを指定します。FALSE の場合、ソート順は大きい値から小さい値の順になります。

公式ドキュメント

LDAPSortKey 構造体は、ソート コントロールで使用するソート条件を格納します。

解説(Remarks)

ldap_create_sort_control 関数および ldap_search_init_page 関数は、この構造体を使用して、結果をクライアントに返す前にどのようにソートするかを指定します。

メモ

winldap.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして LDAPSortKey を定義しています。エンコーディングに依存しないエイリアスを、エンコーディング非依存ではないコードと混在させると、コンパイル エラーや実行時エラーにつながる不一致が発生する可能性があります。詳細については、関数プロトタイプの規約 を参照してください。

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

各言語での定義

#include <windows.h>

// LDAPSortKeyW  (x64 24 / x86 12 バイト)
typedef struct LDAPSortKeyW {
    LPWSTR sk_attrtype;
    LPWSTR sk_matchruleoid;
    BOOLEAN sk_reverseorder;
} LDAPSortKeyW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct LDAPSortKeyW
{
    public IntPtr sk_attrtype;
    public IntPtr sk_matchruleoid;
    [MarshalAs(UnmanagedType.U1)] public bool sk_reverseorder;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure LDAPSortKeyW
    Public sk_attrtype As IntPtr
    Public sk_matchruleoid As IntPtr
    <MarshalAs(UnmanagedType.U1)> Public sk_reverseorder As Boolean
End Structure
import ctypes
from ctypes import wintypes

class LDAPSortKeyW(ctypes.Structure):
    _fields_ = [
        ("sk_attrtype", ctypes.c_void_p),
        ("sk_matchruleoid", ctypes.c_void_p),
        ("sk_reverseorder", ctypes.c_byte),
    ]
#[repr(C)]
pub struct LDAPSortKeyW {
    pub sk_attrtype: *mut core::ffi::c_void,
    pub sk_matchruleoid: *mut core::ffi::c_void,
    pub sk_reverseorder: u8,
}
import "golang.org/x/sys/windows"

type LDAPSortKeyW struct {
	sk_attrtype uintptr
	sk_matchruleoid uintptr
	sk_reverseorder byte
}
type
  LDAPSortKeyW = record
    sk_attrtype: Pointer;
    sk_matchruleoid: Pointer;
    sk_reverseorder: ByteBool;
  end;
const LDAPSortKeyW = extern struct {
    sk_attrtype: ?*anyopaque,
    sk_matchruleoid: ?*anyopaque,
    sk_reverseorder: u8,
};
type
  LDAPSortKeyW {.bycopy.} = object
    sk_attrtype: pointer
    sk_matchruleoid: pointer
    sk_reverseorder: uint8
struct LDAPSortKeyW
{
    void* sk_attrtype;
    void* sk_matchruleoid;
    ubyte sk_reverseorder;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; LDAPSortKeyW サイズ: 12 バイト(x86)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; sk_attrtype : LPWSTR (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; sk_matchruleoid : LPWSTR (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; sk_reverseorder : BOOLEAN (+8, 1byte)  poke st,8,値  /  値 = peek(st,8)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; LDAPSortKeyW サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; sk_attrtype : LPWSTR (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; sk_matchruleoid : LPWSTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; sk_reverseorder : BOOLEAN (+16, 1byte)  poke st,16,値  /  値 = peek(st,16)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global LDAPSortKeyW
    #field intptr sk_attrtype
    #field intptr sk_matchruleoid
    #field bool1 sk_reverseorder
#endstruct

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