SSortOrderSet
構造体サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。
フィールド
| フィールド | 型 | サイズ | x64 | x86 | 説明 |
|---|---|---|---|---|---|
| cSorts | DWORD | 4 | +0 | +0 | aSort 配列に含まれるソート条件の数。 |
| cCategories | DWORD | 4 | +4 | +4 | カテゴリ(グループ化)に用いる先頭の条件数。 |
| cExpanded | DWORD | 4 | +8 | +8 | 初期状態で展開するカテゴリ数。 |
| aSort | SSortOrder | 8 | +12 | +12 | SSortOrder構造体の可変長配列(先頭要素)。 |
公式ドキュメント
適用対象: Outlook 2013 | Outlook 2016
標準ソートまたはカテゴリ別ソートに使用されるテーブルのソートキーのコレクションを定義します。
| プロパティ | 値 |
|---|---|
| ヘッダーファイル: |
Mapidefs.h |
| 関連するマクロ: |
CbNewSSortOrderSet, CbSSortOrderSet, SizedSSortOrderSet |
typedef struct _SSortOrderSet
{
ULONG cSorts;
ULONG cCategories;
ULONG cExpanded;
SSortOrder aSort[MAPI_DIM];
} SSortOrderSet, FAR *LPSSortOrderSet;
解説(Remarks)
SSortOrderSet 構造体は、標準ソートおよびカテゴリ別ソートのために複数のソート順序を定義するために使用されます。
各 SSortOrderSet 構造体には、ソートの方向とソートキーとして使用される列を定義する SSortOrder 構造体が少なくとも 1 つ含まれます。カテゴリ別ソートの場合、この列はカテゴリとして使用されます。cSorts メンバーの値が cCategories メンバーの値を超える場合、カテゴリよりもソートキーの方が多くなり、SSortOrder 配列の先頭に現れる列からカテゴリが作成されます。
たとえば、cSorts に 3、cCategories に 2 が設定されている場合、SSortOrder 配列の最初の 2 つのエントリの ulPropTag メンバーで記述される列がカテゴリ列として使用されます。最初のエントリは最上位のカテゴリグループ化として、2 番目のエントリは 2 次的なグループ化として機能します。2 つのカテゴリ列に一致するすべての行は、3 番目のエントリで定義されたソートキーを使用してソートされます。
cExpanded メンバーは、最初に展開されるカテゴリの数を指定します。カテゴリが複数ある場合、テーブルの実装はカテゴリとして指定される最初の列から開始し、cCategories の数を超えるまで後続のカテゴリ列を順番に処理します。展開される列よりもカテゴリ列の方が多い場合、それらのカテゴリ列は折りたたまれます。cExpanded が 0 の場合、テーブルの利用者が表示できるのは最上位の見出し行のみです。cExpanded がカテゴリ数より 1 小さい場合は、すべての見出し行が利用可能になり、リーフ行はいずれも利用できません。cExpanded がカテゴリ数と等しい場合、テーブルは完全に展開されます。
標準ソートおよびカテゴリ別ソートの詳細については、「Sorting and Categorization」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での定義
#include <windows.h>
// SSortOrder (x64 8 / x86 8 バイト)
typedef struct SSortOrder {
DWORD ulPropTag;
DWORD ulOrder;
} SSortOrder;
// SSortOrderSet (x64 20 / x86 20 バイト)
typedef struct SSortOrderSet {
DWORD cSorts;
DWORD cCategories;
DWORD cExpanded;
SSortOrder aSort[1];
} SSortOrderSet;using System;
using System.Runtime.InteropServices;
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SSortOrder
{
public uint ulPropTag;
public uint ulOrder;
}
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SSortOrderSet
{
public uint cSorts;
public uint cCategories;
public uint cExpanded;
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 1)] public SSortOrder[] aSort;
}Imports System.Runtime.InteropServices
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SSortOrder
Public ulPropTag As UInteger
Public ulOrder As UInteger
End Structure
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SSortOrderSet
Public cSorts As UInteger
Public cCategories As UInteger
Public cExpanded As UInteger
<MarshalAs(UnmanagedType.ByValArray, SizeConst:=1)> Public aSort() As SSortOrder
End Structureimport ctypes
from ctypes import wintypes
class SSortOrder(ctypes.Structure):
_fields_ = [
("ulPropTag", wintypes.DWORD),
("ulOrder", wintypes.DWORD),
]
class SSortOrderSet(ctypes.Structure):
_fields_ = [
("cSorts", wintypes.DWORD),
("cCategories", wintypes.DWORD),
("cExpanded", wintypes.DWORD),
("aSort", SSortOrder * 1),
]#[repr(C)]
pub struct SSortOrder {
pub ulPropTag: u32,
pub ulOrder: u32,
}
#[repr(C)]
pub struct SSortOrderSet {
pub cSorts: u32,
pub cCategories: u32,
pub cExpanded: u32,
pub aSort: [SSortOrder; 1],
}import "golang.org/x/sys/windows"
type SSortOrder struct {
ulPropTag uint32
ulOrder uint32
}
type SSortOrderSet struct {
cSorts uint32
cCategories uint32
cExpanded uint32
aSort [1]SSortOrder
}type
SSortOrder = record
ulPropTag: DWORD;
ulOrder: DWORD;
end;
SSortOrderSet = record
cSorts: DWORD;
cCategories: DWORD;
cExpanded: DWORD;
aSort: array[0..0] of SSortOrder;
end;const SSortOrder = extern struct {
ulPropTag: u32,
ulOrder: u32,
};
const SSortOrderSet = extern struct {
cSorts: u32,
cCategories: u32,
cExpanded: u32,
aSort: [1]SSortOrder,
};type
SSortOrder {.bycopy.} = object
ulPropTag: uint32
ulOrder: uint32
SSortOrderSet {.bycopy.} = object
cSorts: uint32
cCategories: uint32
cExpanded: uint32
aSort: array[1, SSortOrder]struct SSortOrder
{
uint ulPropTag;
uint ulOrder;
}
struct SSortOrderSet
{
uint cSorts;
uint cCategories;
uint cExpanded;
SSortOrder[1] aSort;
}HSP用 定義
HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SSortOrderSet サイズ: 20 バイト(x64)
dim st, 5 ; 4byte整数×5(構造体サイズ 20 / 4 切り上げ)
; cSorts : DWORD (+0, 4byte) st.0 = 値 / 値 = st.0 (lpoke/lpeek も可)
; cCategories : DWORD (+4, 4byte) st.1 = 値 / 値 = st.1 (lpoke/lpeek も可)
; cExpanded : DWORD (+8, 4byte) st.2 = 値 / 値 = st.2 (lpoke/lpeek も可)
; aSort : SSortOrder (+12, 8byte) varptr(st)+12 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global SSortOrder
#field int ulPropTag
#field int ulOrder
#endstruct
#defstruct global SSortOrderSet
#field int cSorts
#field int cCategories
#field int cExpanded
#field SSortOrder aSort 1
#endstruct
stdim st, SSortOrderSet ; NSTRUCT 変数を確保
st->cSorts = 100
mes "cSorts=" + st->cSorts