NOTIFKEY

構造体

サイズx64: 8 バイト / x86: 8 バイト

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

フィールド

フィールド	型	サイズ	x64	x86	説明
cb	DWORD	4	+0	+0	ab配列が保持する通知キーのバイト長。
ab	BYTE	1	+4	+4	通知の識別に用いる可変長バイト列の先頭。アドバイズ登録のキーとなる。

公式ドキュメント

適用対象: Outlook 2013 | Outlook 2016

アドバイズシンク、アドバイズソース、および MAPI の間の接続を一意に識別します。

プロパティ	値
ヘッダーファイル:	Mapispi.h

typedef struct
{
  ULONG cb;
  BYTE ab[MAPI_DIM];
} NOTIFKEY, FAR *LPNOTIFKEY;

解説(Remarks)

IMAPISupport の Subscribe メソッドおよび Notify メソッドは、NOTIFKEY 構造体を使用して、適切なアドバイズソースに関する通知を適切なアドバイズシンクに対して生成します。

サービスプロバイダーは、自身の Advise メソッドが呼び出され、通知の登録とその後の通知の送信を処理するために Subscribe を呼び出す場合に、通知キーを生成します。通知キーには、アドバイズソースのエントリ識別子を使用することも、定数などの他の識別可能な項目を使用することもできます。たとえば、メッセージストアプロバイダーはフォルダーのパスを通知キーとして使用する場合があります。

通知キーは、複数のプロセスにまたがって機能する必要があります。

通知キーのスコープに関する要件は、長期エントリ識別子の要件と似ています。ただし、エントリ識別子とは異なり、通知キーはバイナリ比較が可能でなければなりません。通常、通知キーには、サービスプロバイダーが定義した GUID 値と、それに続くオブジェクトに固有のプロバイダー固有の情報が含まれます。

通知を生成するオブジェクトとアドバイズシンクとの間の接続を管理するための NOTIFKEY 構造体の使用方法については、「Supporting Event Notification」を参照してください。

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

各言語での定義

#include <windows.h>

// NOTIFKEY  (x64 8 / x86 8 バイト)
typedef struct NOTIFKEY {
    DWORD cb;
    BYTE ab[1];
} NOTIFKEY;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct NOTIFKEY
{
    public uint cb;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 1)] public byte[] ab;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure NOTIFKEY
    Public cb As UInteger
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=1)> Public ab() As Byte
End Structure

import ctypes
from ctypes import wintypes

class NOTIFKEY(ctypes.Structure):
    _fields_ = [
        ("cb", wintypes.DWORD),
        ("ab", ctypes.c_ubyte * 1),
    ]

#[repr(C)]
pub struct NOTIFKEY {
    pub cb: u32,
    pub ab: [u8; 1],
}

import "golang.org/x/sys/windows"

type NOTIFKEY struct {
	cb uint32
	ab [1]byte
}

type
  NOTIFKEY = record
    cb: DWORD;
    ab: array[0..0] of Byte;
  end;

const NOTIFKEY = extern struct {
    cb: u32,
    ab: [1]u8,
};

type
  NOTIFKEY {.bycopy.} = object
    cb: uint32
    ab: array[1, uint8]

struct NOTIFKEY
{
    uint cb;
    ubyte[1] ab;
}

HSP用定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; NOTIFKEY サイズ: 8 バイト(x64)
dim st, 2    ; 4byte整数×2(構造体サイズ 8 / 4 切り上げ)
; cb : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; ab : BYTE (+4, 1byte)  varptr(st)+4 を基点に操作(1byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global NOTIFKEY
    #field int cb
    #field byte ab 1
#endstruct

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