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

FAX_GLOBAL_ROUTING_INFOW

構造体
サイズx64: 48 バイト / x86: 28 バイト

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

フィールド

フィールドサイズx64x86説明
SizeOfStructDWORD4+0+0FAX_GLOBAL_ROUTING_INFO 構造体のサイズをバイト単位で指定します。呼び出し元のアプリケーションは、FaxSetGlobalRoutingInfo 関数を呼び出す前に、このメンバーに sizeof(FAX_GLOBAL_ROUTING_INFO) を設定しなければなりません。
PriorityDWORD4+4+4ファックス ルーティング方法の優先度を示す DWORD 変数を指定します。優先度は、ファックス サービスがファックス文書を受信したときにファックス ルーティング方法を呼び出す相対的な順序を決定します。このメンバーの有効な値は 1 から n までで、1 が最も高い優先度です。
GuidLPWSTR8/4+8+8

対象のファックス ルーティング方法を一意に識別する GUID を指定する、null 終端の定数文字列へのポインターです。

ファックス ルーティング方法の詳細については、About the Fax Routing Extension API を参照してください。

FriendlyNameLPWSTR8/4+16+12ファックス ルーティング方法に対して表示するわかりやすい名前を指定する、null 終端の定数文字列へのポインターです。
FunctionNameLPWSTR8/4+24+16指定されたファックス ルーティング方法を実行する関数の名前を表す、null 終端の定数文字列へのポインターです。この関数は、ExtensionImageName メンバーで識別されるファックス ルーティング拡張 DLL がエクスポートします。
ExtensionImageNameLPWSTR8/4+32+20ファックス ルーティング方法を実装するファックス ルーティング拡張 DLL の名前を指定する、null 終端の定数文字列へのポインターです。
ExtensionFriendlyNameLPWSTR8/4+40+24ファックス ルーティング方法を実装するファックス ルーティング拡張 DLL に対して表示するわかりやすい名前を指定する、null 終端の定数文字列へのポインターです。

公式ドキュメント

FAX_GLOBAL_ROUTING_INFO 構造体は、ファックス サービス全体に適用される 1 つのファックス ルーティング方法に関する情報を格納します。この構造体には、ファックス ルーティング方法の優先度レベルと、そのルーティング方法をエクスポートする DLL の名前が含まれます。また、ファックス ルーティング方法を識別する GUID と関数名、およびその方法のわかりやすい名前も含まれます。

ファックス ルーティング方法を識別するには Guid メンバーが必要です。現在、アプリケーションが変更できるメンバーは Priority メンバーのみです。

解説(Remarks)

ファックス クライアント アプリケーションは、FaxEnumGlobalRoutingInfo 関数を呼び出すことで、ファックス サービス全体に適用されるファックス ルーティング方法の情報を取得できます。この関数は、各ファックス ルーティング方法に関する情報を個別の FAX_GLOBAL_ROUTING_INFO 構造体で返します。

ルーティングの優先度など、ファックス サーバー全体に適用されるファックス ルーティング方法のデータを変更するには、FaxSetGlobalRoutingInfo 関数を呼び出します。

詳細については、Managing Global Fax Routing Data を参照してください。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FAX_GLOBAL_ROUTING_INFO を定義します。エンコード中立のエイリアスを、エンコード中立でないコードと混在させて使用すると、不整合が生じてコンパイル エラーや実行時エラーの原因となる可能性があります。詳細については、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>

// FAX_GLOBAL_ROUTING_INFOW  (x64 48 / x86 28 バイト)
typedef struct FAX_GLOBAL_ROUTING_INFOW {
    DWORD SizeOfStruct;
    DWORD Priority;
    LPWSTR Guid;
    LPWSTR FriendlyName;
    LPWSTR FunctionName;
    LPWSTR ExtensionImageName;
    LPWSTR ExtensionFriendlyName;
} FAX_GLOBAL_ROUTING_INFOW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FAX_GLOBAL_ROUTING_INFOW
{
    public uint SizeOfStruct;
    public uint Priority;
    public IntPtr Guid;
    public IntPtr FriendlyName;
    public IntPtr FunctionName;
    public IntPtr ExtensionImageName;
    public IntPtr ExtensionFriendlyName;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure FAX_GLOBAL_ROUTING_INFOW
    Public SizeOfStruct As UInteger
    Public Priority As UInteger
    Public Guid As IntPtr
    Public FriendlyName As IntPtr
    Public FunctionName As IntPtr
    Public ExtensionImageName As IntPtr
    Public ExtensionFriendlyName As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class FAX_GLOBAL_ROUTING_INFOW(ctypes.Structure):
    _fields_ = [
        ("SizeOfStruct", wintypes.DWORD),
        ("Priority", wintypes.DWORD),
        ("Guid", ctypes.c_void_p),
        ("FriendlyName", ctypes.c_void_p),
        ("FunctionName", ctypes.c_void_p),
        ("ExtensionImageName", ctypes.c_void_p),
        ("ExtensionFriendlyName", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct FAX_GLOBAL_ROUTING_INFOW {
    pub SizeOfStruct: u32,
    pub Priority: u32,
    pub Guid: *mut core::ffi::c_void,
    pub FriendlyName: *mut core::ffi::c_void,
    pub FunctionName: *mut core::ffi::c_void,
    pub ExtensionImageName: *mut core::ffi::c_void,
    pub ExtensionFriendlyName: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type FAX_GLOBAL_ROUTING_INFOW struct {
	SizeOfStruct uint32
	Priority uint32
	Guid uintptr
	FriendlyName uintptr
	FunctionName uintptr
	ExtensionImageName uintptr
	ExtensionFriendlyName uintptr
}
type
  FAX_GLOBAL_ROUTING_INFOW = record
    SizeOfStruct: DWORD;
    Priority: DWORD;
    Guid: Pointer;
    FriendlyName: Pointer;
    FunctionName: Pointer;
    ExtensionImageName: Pointer;
    ExtensionFriendlyName: Pointer;
  end;
const FAX_GLOBAL_ROUTING_INFOW = extern struct {
    SizeOfStruct: u32,
    Priority: u32,
    Guid: ?*anyopaque,
    FriendlyName: ?*anyopaque,
    FunctionName: ?*anyopaque,
    ExtensionImageName: ?*anyopaque,
    ExtensionFriendlyName: ?*anyopaque,
};
type
  FAX_GLOBAL_ROUTING_INFOW {.bycopy.} = object
    SizeOfStruct: uint32
    Priority: uint32
    Guid: pointer
    FriendlyName: pointer
    FunctionName: pointer
    ExtensionImageName: pointer
    ExtensionFriendlyName: pointer
struct FAX_GLOBAL_ROUTING_INFOW
{
    uint SizeOfStruct;
    uint Priority;
    void* Guid;
    void* FriendlyName;
    void* FunctionName;
    void* ExtensionImageName;
    void* ExtensionFriendlyName;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; FAX_GLOBAL_ROUTING_INFOW サイズ: 28 バイト(x86)
dim st, 7    ; 4byte整数×7(構造体サイズ 28 / 4 切り上げ)
; SizeOfStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Priority : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Guid : LPWSTR (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; FriendlyName : LPWSTR (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; FunctionName : LPWSTR (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; ExtensionImageName : LPWSTR (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ExtensionFriendlyName : LPWSTR (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; FAX_GLOBAL_ROUTING_INFOW サイズ: 48 バイト(x64)
dim st, 12    ; 4byte整数×12(構造体サイズ 48 / 4 切り上げ)
; SizeOfStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Priority : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Guid : LPWSTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; FriendlyName : LPWSTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; FunctionName : LPWSTR (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; ExtensionImageName : LPWSTR (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; ExtensionFriendlyName : LPWSTR (+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_GLOBAL_ROUTING_INFOW
    #field int SizeOfStruct
    #field int Priority
    #field intptr Guid
    #field intptr FriendlyName
    #field intptr FunctionName
    #field intptr ExtensionImageName
    #field intptr ExtensionFriendlyName
#endstruct

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