FAX_ROUTING_METHODA

構造体

サイズx64: 64 バイト / x86: 36 バイト

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

フィールド

フィールド	型	サイズ	x64	x86	説明
SizeOfStruct	DWORD	4	+0	+0	FAX_ROUTING_METHOD 構造体のサイズをバイト単位で指定します。ファックスサービスはこのメンバーに sizeof(FAX_ROUTING_METHOD) を設定します。
DeviceId	DWORD	4	+4	+4	対象のファックスデバイスの永続的な回線識別子を示す DWORD 変数を指定します。
Enabled	BOOL	4	+8	+8	対象のファックスデバイスでファックスルーティング方法が有効か無効かを示すブール変数を指定します。このパラメーターが TRUE の場合、そのデバイスでファックスルーティング方法は有効です。
DeviceName	LPSTR	8/4	+16	+12	対象のファックスデバイスの名前を指定する、NULL で終わる定数文字列へのポインターです。
Guid	LPSTR	8/4	+24	+16	対象のファックスルーティング方法を一意に識別する GUID を指定する、NULL で終わる定数文字列へのポインターです。ファックスルーティング方法の詳細については、About the Fax Routing Extension API を参照してください。
FriendlyName	LPSTR	8/4	+32	+20	ファックスルーティング方法として表示する、わかりやすい名前を指定する、NULL で終わる定数文字列へのポインターです。
FunctionName	LPSTR	8/4	+40	+24	指定されたファックスルーティング処理を実行する関数の名前である、NULL で終わる定数文字列へのポインターです。この関数は、ExtensionImageName メンバーで識別されるファックスルーティング拡張 DLL がエクスポートします。
ExtensionImageName	LPSTR	8/4	+48	+28	ファックスルーティング方法を実装するファックスルーティング拡張 DLL の名前を指定する、NULL で終わる定数文字列へのポインターです。
ExtensionFriendlyName	LPSTR	8/4	+56	+32	ファックスルーティング拡張 DLL として表示する、わかりやすい名前を指定する、NULL で終わる定数文字列へのポインターです。

公式ドキュメント

FAX_ROUTING_METHOD 構造体は、1 つのファックスデバイスに関連する 1 つのファックスルーティング方法についての情報を格納します。このデータには、そのデバイスでファックスルーティング方法が有効になっているかどうか、およびルーティング方法をエクスポートする DLL の名前などが含まれます。さらに、ルーティング方法を一意に識別する GUID と関数名、およびその方法のわかりやすい名前も含まれます。

解説(Remarks)

ファックスクライアントアプリケーションは、FaxEnumRoutingMethods 関数を呼び出すことで、特定のファックスデバイスに関連付けられたすべてのファックスルーティング方法を列挙できます。この関数は FAX_ROUTING_METHOD 構造体の配列を返します。各構造体は 1 つのファックスルーティング方法を詳細に記述します。

特定のファックスデバイスに対してファックスルーティング方法を有効または無効にするには、FaxEnableRoutingMethod 関数を呼び出します。

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

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして FAX_ROUTING_METHOD を定義します。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、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_ROUTING_METHODA  (x64 64 / x86 36 バイト)
typedef struct FAX_ROUTING_METHODA {
    DWORD SizeOfStruct;
    DWORD DeviceId;
    BOOL Enabled;
    LPSTR DeviceName;
    LPSTR Guid;
    LPSTR FriendlyName;
    LPSTR FunctionName;
    LPSTR ExtensionImageName;
    LPSTR ExtensionFriendlyName;
} FAX_ROUTING_METHODA;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FAX_ROUTING_METHODA
{
    public uint SizeOfStruct;
    public uint DeviceId;
    [MarshalAs(UnmanagedType.Bool)] public bool Enabled;
    public IntPtr DeviceName;
    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_ROUTING_METHODA
    Public SizeOfStruct As UInteger
    Public DeviceId As UInteger
    <MarshalAs(UnmanagedType.Bool)> Public Enabled As Boolean
    Public DeviceName As IntPtr
    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_ROUTING_METHODA(ctypes.Structure):
    _fields_ = [
        ("SizeOfStruct", wintypes.DWORD),
        ("DeviceId", wintypes.DWORD),
        ("Enabled", wintypes.BOOL),
        ("DeviceName", ctypes.c_void_p),
        ("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_ROUTING_METHODA {
    pub SizeOfStruct: u32,
    pub DeviceId: u32,
    pub Enabled: i32,
    pub DeviceName: *mut core::ffi::c_void,
    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_ROUTING_METHODA struct {
	SizeOfStruct uint32
	DeviceId uint32
	Enabled int32
	DeviceName uintptr
	Guid uintptr
	FriendlyName uintptr
	FunctionName uintptr
	ExtensionImageName uintptr
	ExtensionFriendlyName uintptr
}

type
  FAX_ROUTING_METHODA = record
    SizeOfStruct: DWORD;
    DeviceId: DWORD;
    Enabled: BOOL;
    DeviceName: Pointer;
    Guid: Pointer;
    FriendlyName: Pointer;
    FunctionName: Pointer;
    ExtensionImageName: Pointer;
    ExtensionFriendlyName: Pointer;
  end;

const FAX_ROUTING_METHODA = extern struct {
    SizeOfStruct: u32,
    DeviceId: u32,
    Enabled: i32,
    DeviceName: ?*anyopaque,
    Guid: ?*anyopaque,
    FriendlyName: ?*anyopaque,
    FunctionName: ?*anyopaque,
    ExtensionImageName: ?*anyopaque,
    ExtensionFriendlyName: ?*anyopaque,
};

type
  FAX_ROUTING_METHODA {.bycopy.} = object
    SizeOfStruct: uint32
    DeviceId: uint32
    Enabled: int32
    DeviceName: pointer
    Guid: pointer
    FriendlyName: pointer
    FunctionName: pointer
    ExtensionImageName: pointer
    ExtensionFriendlyName: pointer

struct FAX_ROUTING_METHODA
{
    uint SizeOfStruct;
    uint DeviceId;
    int Enabled;
    void* DeviceName;
    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_ROUTING_METHODA サイズ: 36 バイト(x86)
dim st, 9    ; 4byte整数×9(構造体サイズ 36 / 4 切り上げ)
; SizeOfStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; DeviceId : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Enabled : BOOL (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; DeviceName : LPSTR (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; Guid : LPSTR (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; FriendlyName : LPSTR (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; FunctionName : LPSTR (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; ExtensionImageName : LPSTR (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; ExtensionFriendlyName : LPSTR (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; FAX_ROUTING_METHODA サイズ: 64 バイト(x64)
dim st, 16    ; 4byte整数×16(構造体サイズ 64 / 4 切り上げ)
; SizeOfStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; DeviceId : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Enabled : BOOL (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; DeviceName : LPSTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; Guid : LPSTR (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; FriendlyName : LPSTR (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; FunctionName : LPSTR (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; ExtensionImageName : LPSTR (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; ExtensionFriendlyName : LPSTR (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global FAX_ROUTING_METHODA
    #field int SizeOfStruct
    #field int DeviceId
    #field bool Enabled
    #field intptr DeviceName
    #field intptr Guid
    #field intptr FriendlyName
    #field intptr FunctionName
    #field intptr ExtensionImageName
    #field intptr ExtensionFriendlyName
#endstruct

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