Win32 API 日本語リファレンス
ホーム › Devices.Fax › FAX_ROUTE_CALLBACKROUTINES

FAX_ROUTE_CALLBACKROUTINES

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 48 バイト / x86: 24 バイト

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

フィールド

フィールド型サイズx64x86説明
SizeOfStructDWORD4+0+0FAX_ROUTE_CALLBACKROUTINES 構造体のサイズをバイト単位で指定します。ファックス サービスは、このメンバーに sizeof(FAX_ROUTE_CALLBACKROUTINES) を設定します。下位互換性については、後述の「解説」セクションを参照してください。
FaxRouteAddFilePFAXROUTEADDFILE8/4+8+4ファックス ルーティング メソッドが、受信したファックス ドキュメントに関連付けられたファックス ファイル リストにファイルを追加するために使用する FaxRouteAddFile コールバック関数へのポインターです。
FaxRouteDeleteFilePFAXROUTEDELETEFILE8/4+16+8ファックス ルーティング メソッドが、受信したファックス ドキュメントに関連付けられたファックス ファイル リストからファイルを削除するために使用する FaxRouteDeleteFile コールバック関数へのポインターです。
FaxRouteGetFilePFAXROUTEGETFILE8/4+24+12ファックス ルーティング メソッドが、受信したファックス ドキュメントに関連付けられたファックス ファイル リストから特定のファイル名を取得するために使用する FaxRouteGetFile コールバック関数へのポインターです。
FaxRouteEnumFilesPFAXROUTEENUMFILES8/4+32+16ファックス ルーティング メソッドが、受信したファックス ドキュメントに関連付けられたファックス ファイル リスト内のファイルを列挙するために使用する FaxRouteEnumFiles コールバック関数へのポインターです。
FaxRouteModifyRoutingDataPFAXROUTEMODIFYROUTINGDATA8/4+40+20ファックス ルーティング メソッドが、後続のファックス ルーティング メソッドに関連付けられたルーティング データを変更するために使用する FaxRouteModifyRoutingData コールバック関数へのポインターです。

公式ドキュメント

FAX_ROUTE_CALLBACKROUTINES 構造体には、ファックス サービスが提供するコールバック関数へのポインターが格納されます。ファックス ルーティング拡張機能のルーティング メソッドは、これらのコールバック関数を呼び出して、受信したファックス ドキュメントに関連付けられたファックス ファイル リスト内のファイルを管理できます。

解説(Remarks)

ファックス ルーティング拡張機能 DLL は、これらのコールバック関数へのポインターを後で使用するためにグローバル変数に保存する必要があります。

SizeOfStruct メンバーが sizeof(FAX_ROUTE_CALLBACKROUTINES) より大きい場合、FAX_ROUTE_CALLBACKROUTINES 構造体が Microsoft によって更新されており、アプリケーションが以前のバージョンを使用していることを示します。下位互換性を維持するため、変更は FAX_ROUTE_CALLBACKROUTINES 構造体の元のプロトタイプの末尾に追加されます。たとえば、追加のコールバック関数用の新しいメンバーは、FaxRouteModifyRoutingData メンバーの後に順次追加されます。

詳細については、Fax Routing Extension Registration および Fax File Lists を参照してください。

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

各言語での定義

#include <windows.h>

// FAX_ROUTE_CALLBACKROUTINES  (x64 48 / x86 24 バイト)
typedef struct FAX_ROUTE_CALLBACKROUTINES {
    DWORD SizeOfStruct;
    PFAXROUTEADDFILE FaxRouteAddFile;
    PFAXROUTEDELETEFILE FaxRouteDeleteFile;
    PFAXROUTEGETFILE FaxRouteGetFile;
    PFAXROUTEENUMFILES FaxRouteEnumFiles;
    PFAXROUTEMODIFYROUTINGDATA FaxRouteModifyRoutingData;
} FAX_ROUTE_CALLBACKROUTINES;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FAX_ROUTE_CALLBACKROUTINES
{
    public uint SizeOfStruct;
    public IntPtr FaxRouteAddFile;
    public IntPtr FaxRouteDeleteFile;
    public IntPtr FaxRouteGetFile;
    public IntPtr FaxRouteEnumFiles;
    public IntPtr FaxRouteModifyRoutingData;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure FAX_ROUTE_CALLBACKROUTINES
    Public SizeOfStruct As UInteger
    Public FaxRouteAddFile As IntPtr
    Public FaxRouteDeleteFile As IntPtr
    Public FaxRouteGetFile As IntPtr
    Public FaxRouteEnumFiles As IntPtr
    Public FaxRouteModifyRoutingData As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class FAX_ROUTE_CALLBACKROUTINES(ctypes.Structure):
    _fields_ = [
        ("SizeOfStruct", wintypes.DWORD),
        ("FaxRouteAddFile", ctypes.c_void_p),
        ("FaxRouteDeleteFile", ctypes.c_void_p),
        ("FaxRouteGetFile", ctypes.c_void_p),
        ("FaxRouteEnumFiles", ctypes.c_void_p),
        ("FaxRouteModifyRoutingData", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct FAX_ROUTE_CALLBACKROUTINES {
    pub SizeOfStruct: u32,
    pub FaxRouteAddFile: *mut core::ffi::c_void,
    pub FaxRouteDeleteFile: *mut core::ffi::c_void,
    pub FaxRouteGetFile: *mut core::ffi::c_void,
    pub FaxRouteEnumFiles: *mut core::ffi::c_void,
    pub FaxRouteModifyRoutingData: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type FAX_ROUTE_CALLBACKROUTINES struct {
	SizeOfStruct uint32
	FaxRouteAddFile uintptr
	FaxRouteDeleteFile uintptr
	FaxRouteGetFile uintptr
	FaxRouteEnumFiles uintptr
	FaxRouteModifyRoutingData uintptr
}
type
  FAX_ROUTE_CALLBACKROUTINES = record
    SizeOfStruct: DWORD;
    FaxRouteAddFile: Pointer;
    FaxRouteDeleteFile: Pointer;
    FaxRouteGetFile: Pointer;
    FaxRouteEnumFiles: Pointer;
    FaxRouteModifyRoutingData: Pointer;
  end;
const FAX_ROUTE_CALLBACKROUTINES = extern struct {
    SizeOfStruct: u32,
    FaxRouteAddFile: ?*anyopaque,
    FaxRouteDeleteFile: ?*anyopaque,
    FaxRouteGetFile: ?*anyopaque,
    FaxRouteEnumFiles: ?*anyopaque,
    FaxRouteModifyRoutingData: ?*anyopaque,
};
type
  FAX_ROUTE_CALLBACKROUTINES {.bycopy.} = object
    SizeOfStruct: uint32
    FaxRouteAddFile: pointer
    FaxRouteDeleteFile: pointer
    FaxRouteGetFile: pointer
    FaxRouteEnumFiles: pointer
    FaxRouteModifyRoutingData: pointer
struct FAX_ROUTE_CALLBACKROUTINES
{
    uint SizeOfStruct;
    void* FaxRouteAddFile;
    void* FaxRouteDeleteFile;
    void* FaxRouteGetFile;
    void* FaxRouteEnumFiles;
    void* FaxRouteModifyRoutingData;
}

HSP用 定義

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

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

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