FAX_SEND
構造体サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。
フィールド
| フィールド | 型 | サイズ | x64 | x86 | 説明 |
|---|---|---|---|---|---|
| SizeOfStruct | DWORD | 4 | +0 | +0 | FAX_SEND 構造体のサイズをバイト単位で指定します。FaxDevSend 関数を呼び出す前に、ファクス サービスはこのメンバーに sizeof(FAX_SEND) を設定します。 |
| FileName | LPWSTR | 8/4 | +8 | +4 | 送信するファクス ドキュメントのデータ ストリームを格納するファイルへの完全パスを指定する、null で終わる Unicode 文字列へのポインターです。データ ストリームは TIFF Class F ファイルです。詳細については、Fax Image Format を参照してください。 |
| CallerName | LPWSTR | 8/4 | +16 | +8 | 発信側デバイスの名前を指定する、null で終わる Unicode 文字列へのポインターです。FSP はファクスを送信するときに、この名前をリモートの受信側デバイスに送信します。詳細については、後述の「解説」セクションを参照してください。 |
| CallerNumber | LPWSTR | 8/4 | +24 | +12 | 発信側デバイスの電話番号を指定する、null で終わる Unicode 文字列へのポインターです (この番号は TSID でもあります)。FSP はファクスを送信するときに、この番号をリモートの受信側デバイスに送信します。詳細については、後述の「解説」セクションを参照してください。 |
| ReceiverName | LPWSTR | 8/4 | +32 | +16 | 送信するファクス ドキュメントを受信するデバイスの名前を指定する、null で終わる Unicode 文字列へのポインターです。 |
| ReceiverNumber | LPWSTR | 8/4 | +40 | +20 | 送信するファクス ドキュメントを受信するデバイスの電話番号を指定する、null で終わる Unicode 文字列へのポインターです。これは FSP がダイヤルする電話番号です。 CallHandle メンバーを指定する場合、ReceiverNumber メンバーは NULL でなければなりません。 |
| Branding | BOOL | 4 | +48 | +24 | 予約済みです。 |
| CallHandle | DWORD | 4 | +52 | +28 | 予約済みです。NULL に設定しなければなりません。 |
| Reserved | DWORD | 12 | +56 | +32 | このメンバーは Microsoft によって予約されています。0 に設定しなければなりません。 |
公式ドキュメント
FAX_SEND 構造体は、送信するファクス ドキュメントに関する情報を格納します。この構造体には、ファクスのデータ ストリームを保持するファイルの名前、発信側デバイスの名前と電話番号、および受信側デバイスの名前と電話番号が含まれます。
解説(Remarks)
FSP は CallerName メンバーと CallerNumber メンバーを再フォーマットできます。その後 FSP は、国際電気通信連合 (ITU) の Study Group 8 (SG8) による標準化団体の勧告に準拠するために、再フォーマットしたデータを着信側加入者識別子 (CSI) としてリモートの送信側デバイスに送信できます。詳細については、FAX_DEV_STATUS 構造体の RoutingInfo メンバーおよび CSI メンバーを参照してください。
FSP は、再フォーマットしたデータを使用してファクス送信にブランドを追加することもできます。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での定義
#include <windows.h>
// FAX_SEND (x64 72 / x86 44 バイト)
typedef struct FAX_SEND {
DWORD SizeOfStruct;
LPWSTR FileName;
LPWSTR CallerName;
LPWSTR CallerNumber;
LPWSTR ReceiverName;
LPWSTR ReceiverNumber;
BOOL Branding;
DWORD CallHandle;
DWORD Reserved[3];
} FAX_SEND;using System;
using System.Runtime.InteropServices;
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FAX_SEND
{
public uint SizeOfStruct;
public IntPtr FileName;
public IntPtr CallerName;
public IntPtr CallerNumber;
public IntPtr ReceiverName;
public IntPtr ReceiverNumber;
[MarshalAs(UnmanagedType.Bool)] public bool Branding;
public uint CallHandle;
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 3)] public uint[] Reserved;
}Imports System.Runtime.InteropServices
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure FAX_SEND
Public SizeOfStruct As UInteger
Public FileName As IntPtr
Public CallerName As IntPtr
Public CallerNumber As IntPtr
Public ReceiverName As IntPtr
Public ReceiverNumber As IntPtr
<MarshalAs(UnmanagedType.Bool)> Public Branding As Boolean
Public CallHandle As UInteger
<MarshalAs(UnmanagedType.ByValArray, SizeConst:=3)> Public Reserved() As UInteger
End Structureimport ctypes
from ctypes import wintypes
class FAX_SEND(ctypes.Structure):
_fields_ = [
("SizeOfStruct", wintypes.DWORD),
("FileName", ctypes.c_void_p),
("CallerName", ctypes.c_void_p),
("CallerNumber", ctypes.c_void_p),
("ReceiverName", ctypes.c_void_p),
("ReceiverNumber", ctypes.c_void_p),
("Branding", wintypes.BOOL),
("CallHandle", wintypes.DWORD),
("Reserved", wintypes.DWORD * 3),
]#[repr(C)]
pub struct FAX_SEND {
pub SizeOfStruct: u32,
pub FileName: *mut core::ffi::c_void,
pub CallerName: *mut core::ffi::c_void,
pub CallerNumber: *mut core::ffi::c_void,
pub ReceiverName: *mut core::ffi::c_void,
pub ReceiverNumber: *mut core::ffi::c_void,
pub Branding: i32,
pub CallHandle: u32,
pub Reserved: [u32; 3],
}import "golang.org/x/sys/windows"
type FAX_SEND struct {
SizeOfStruct uint32
FileName uintptr
CallerName uintptr
CallerNumber uintptr
ReceiverName uintptr
ReceiverNumber uintptr
Branding int32
CallHandle uint32
Reserved [3]uint32
}type
FAX_SEND = record
SizeOfStruct: DWORD;
FileName: Pointer;
CallerName: Pointer;
CallerNumber: Pointer;
ReceiverName: Pointer;
ReceiverNumber: Pointer;
Branding: BOOL;
CallHandle: DWORD;
Reserved: array[0..2] of DWORD;
end;const FAX_SEND = extern struct {
SizeOfStruct: u32,
FileName: ?*anyopaque,
CallerName: ?*anyopaque,
CallerNumber: ?*anyopaque,
ReceiverName: ?*anyopaque,
ReceiverNumber: ?*anyopaque,
Branding: i32,
CallHandle: u32,
Reserved: [3]u32,
};type
FAX_SEND {.bycopy.} = object
SizeOfStruct: uint32
FileName: pointer
CallerName: pointer
CallerNumber: pointer
ReceiverName: pointer
ReceiverNumber: pointer
Branding: int32
CallHandle: uint32
Reserved: array[3, uint32]struct FAX_SEND
{
uint SizeOfStruct;
void* FileName;
void* CallerName;
void* CallerNumber;
void* ReceiverName;
void* ReceiverNumber;
int Branding;
uint CallHandle;
uint[3] Reserved;
}HSP用 定義
HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; FAX_SEND サイズ: 44 バイト(x86)
dim st, 11 ; 4byte整数×11(構造体サイズ 44 / 4 切り上げ)
; SizeOfStruct : DWORD (+0, 4byte) st.0 = 値 / 値 = st.0 (lpoke/lpeek も可)
; FileName : LPWSTR (+4, 4byte) st.1 = 値 / 値 = st.1 (lpoke/lpeek も可)
; CallerName : LPWSTR (+8, 4byte) st.2 = 値 / 値 = st.2 (lpoke/lpeek も可)
; CallerNumber : LPWSTR (+12, 4byte) st.3 = 値 / 値 = st.3 (lpoke/lpeek も可)
; ReceiverName : LPWSTR (+16, 4byte) st.4 = 値 / 値 = st.4 (lpoke/lpeek も可)
; ReceiverNumber : LPWSTR (+20, 4byte) st.5 = 値 / 値 = st.5 (lpoke/lpeek も可)
; Branding : BOOL (+24, 4byte) st.6 = 値 / 値 = st.6 (lpoke/lpeek も可)
; CallHandle : DWORD (+28, 4byte) st.7 = 値 / 値 = st.7 (lpoke/lpeek も可)
; Reserved : DWORD (+32, 12byte) varptr(st)+32 を基点に操作(12byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; FAX_SEND サイズ: 72 バイト(x64)
dim st, 18 ; 4byte整数×18(構造体サイズ 72 / 4 切り上げ)
; SizeOfStruct : DWORD (+0, 4byte) st.0 = 値 / 値 = st.0 (lpoke/lpeek も可)
; FileName : LPWSTR (+8, 8byte) qpoke st,8,値 / qpeek(st,8) ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; CallerName : LPWSTR (+16, 8byte) qpoke st,16,値 / qpeek(st,16) ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; CallerNumber : LPWSTR (+24, 8byte) qpoke st,24,値 / qpeek(st,24) ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; ReceiverName : LPWSTR (+32, 8byte) qpoke st,32,値 / qpeek(st,32) ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; ReceiverNumber : LPWSTR (+40, 8byte) qpoke st,40,値 / qpeek(st,40) ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; Branding : BOOL (+48, 4byte) st.12 = 値 / 値 = st.12 (lpoke/lpeek も可)
; CallHandle : DWORD (+52, 4byte) st.13 = 値 / 値 = st.13 (lpoke/lpeek も可)
; Reserved : DWORD (+56, 12byte) varptr(st)+56 を基点に操作(12byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global FAX_SEND
#field int SizeOfStruct
#field intptr FileName
#field intptr CallerName
#field intptr CallerNumber
#field intptr ReceiverName
#field intptr ReceiverNumber
#field bool Branding
#field int CallHandle
#field int Reserved 3
#endstruct
stdim st, FAX_SEND ; NSTRUCT 変数を確保
st->SizeOfStruct = 100
mes "SizeOfStruct=" + st->SizeOfStruct