ホーム › Devices.Fax › FAX_RECEIVE
FAX_RECEIVE
構造体サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。
フィールド
| フィールド | 型 | サイズ | x64 | x86 | 説明 |
|---|---|---|---|---|---|
| SizeOfStruct | DWORD | 4 | +0 | +0 | FAX_RECEIVE 構造体のサイズをバイト単位で指定します。ファクス サービスは FaxDevReceive 関数を呼び出す前に、このメンバーに sizeof(FAX_RECEIVE) を設定します。詳細については、後述の「解説」セクションを参照してください。 |
| FileName | LPWSTR | 8/4 | +8 | +4 | FSP が受信ファクス文書のデータ ストリームを格納しなければならないファイルのフル パスを指定する、null で終わる Unicode 文字列へのポインターです。このデータ ストリームは TIFF Class F ファイルです。詳細については、Fax Image Format を参照してください。ファクス サービスは、FaxDevReceive 関数を呼び出す前にこのファイルを作成します。FSP は、このファイルを開くときに OPEN_EXISTING フラグを指定しなければなりません。 |
| ReceiverName | LPWSTR | 8/4 | +16 | +8 | 受信デバイスの名前を指定する、null で終わる Unicode 文字列へのポインターです。FSP は、受信デバイスが受信ファクスを受け取った後、この名前をリモートの送信デバイスに送信します。詳細については、後述の「解説」セクションを参照してください。 |
| ReceiverNumber | LPWSTR | 8/4 | +24 | +12 | 受信デバイスの電話番号を指定する、null で終わる Unicode 文字列へのポインターです。FSP は、受信デバイスが受信ファクスを受け取った後、この番号をリモートの送信デバイスに送信します。詳細については、後述の「解説」セクションを参照してください。 |
| Reserved | DWORD | 16 | +32 | +16 | このメンバーは、Microsoft が将来使用するために予約済みです。0 に設定しなければなりません。 |
公式ドキュメント
FAX_RECEIVE 構造体は、受信ファクス文書に関する情報を格納します。この情報には、ファクスのデータ ストリームを受け取るファイルの名前、および受信デバイスの名前と電話番号が含まれます。
解説(Remarks)
FSP は、この構造体の ReceiverName メンバーと ReceiverNumber メンバーを設定しなければなりません。これらの文字列用のメモリは、ファクス サービスが割り当てます。サービスが割り当てるメモリのサイズは、sizeof(FAX_RECEIVE) + FAXDEVRECEIVE_SIZE です。FSP は、FAX_RECEIVE 構造体に続くメモリ ブロック内にこれらの文字列を配置しなければなりません。なお、FAX_RECEIVE 構造体の直後に続く FileName 文字列のサイズを考慮する必要があります。ReceiverName メンバーと ReceiverNumber メンバーは、メモリ ブロック内の文字列の位置を指していなければなりません。
次のコード サンプルと図は、ファクス サービスが割り当てたメモリを埋める方法を示しています。
PWSTR ReceiverName;
PWSTR ReceiverNumber;
//
// Routine to retrieve the receiver name
// and receiver number here.
//
// Set the receiver name and receiver number data
// in the FAX_RECEIVE structure; then
// copy the data to the appropriate offset.
//
FaxReceive->ReceiverNumber = (LPWSTR) ( (LPBYTE)FaxReceive->FileName + sizeof(WCHAR)*(wcslen(FaxReceive->FileName) + 1));
wcscpy_s( FaxReceive->ReceiverNumber, ReceiverNumber );
FaxReceive->ReceiverName = (LPWSTR) ( (LPBYTE)FaxReceive->ReceiverNumber+ sizeof(WCHAR)*(wcslen(FaxReceive->ReceiverNumber) + 1));
wcscpy_s( FaxReceive->ReceiverName, ReceiverName );
FSP は、国際電気通信連合 (ITU) の Study Group 8 (SG8) による標準化団体の勧告に準拠するために、ReceiverName メンバーと ReceiverNumber メンバーを再フォーマットし、再フォーマットしたデータを着信側加入者識別子 (CSI) としてリモートの送信デバイスに送信できます。詳細については、FAX_DEV_STATUS 構造体の RoutingInfo メンバーと CSI メンバーを参照してください。出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での定義
#include <windows.h>
// FAX_RECEIVE (x64 48 / x86 32 バイト)
typedef struct FAX_RECEIVE {
DWORD SizeOfStruct;
LPWSTR FileName;
LPWSTR ReceiverName;
LPWSTR ReceiverNumber;
DWORD Reserved[4];
} FAX_RECEIVE;using System;
using System.Runtime.InteropServices;
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FAX_RECEIVE
{
public uint SizeOfStruct;
public IntPtr FileName;
public IntPtr ReceiverName;
public IntPtr ReceiverNumber;
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 4)] public uint[] Reserved;
}Imports System.Runtime.InteropServices
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure FAX_RECEIVE
Public SizeOfStruct As UInteger
Public FileName As IntPtr
Public ReceiverName As IntPtr
Public ReceiverNumber As IntPtr
<MarshalAs(UnmanagedType.ByValArray, SizeConst:=4)> Public Reserved() As UInteger
End Structureimport ctypes
from ctypes import wintypes
class FAX_RECEIVE(ctypes.Structure):
_fields_ = [
("SizeOfStruct", wintypes.DWORD),
("FileName", ctypes.c_void_p),
("ReceiverName", ctypes.c_void_p),
("ReceiverNumber", ctypes.c_void_p),
("Reserved", wintypes.DWORD * 4),
]#[repr(C)]
pub struct FAX_RECEIVE {
pub SizeOfStruct: u32,
pub FileName: *mut core::ffi::c_void,
pub ReceiverName: *mut core::ffi::c_void,
pub ReceiverNumber: *mut core::ffi::c_void,
pub Reserved: [u32; 4],
}import "golang.org/x/sys/windows"
type FAX_RECEIVE struct {
SizeOfStruct uint32
FileName uintptr
ReceiverName uintptr
ReceiverNumber uintptr
Reserved [4]uint32
}type
FAX_RECEIVE = record
SizeOfStruct: DWORD;
FileName: Pointer;
ReceiverName: Pointer;
ReceiverNumber: Pointer;
Reserved: array[0..3] of DWORD;
end;const FAX_RECEIVE = extern struct {
SizeOfStruct: u32,
FileName: ?*anyopaque,
ReceiverName: ?*anyopaque,
ReceiverNumber: ?*anyopaque,
Reserved: [4]u32,
};type
FAX_RECEIVE {.bycopy.} = object
SizeOfStruct: uint32
FileName: pointer
ReceiverName: pointer
ReceiverNumber: pointer
Reserved: array[4, uint32]struct FAX_RECEIVE
{
uint SizeOfStruct;
void* FileName;
void* ReceiverName;
void* ReceiverNumber;
uint[4] 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_RECEIVE サイズ: 32 バイト(x86)
dim st, 8 ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; SizeOfStruct : DWORD (+0, 4byte) st.0 = 値 / 値 = st.0 (lpoke/lpeek も可)
; FileName : LPWSTR (+4, 4byte) st.1 = 値 / 値 = st.1 (lpoke/lpeek も可)
; ReceiverName : LPWSTR (+8, 4byte) st.2 = 値 / 値 = st.2 (lpoke/lpeek も可)
; ReceiverNumber : LPWSTR (+12, 4byte) st.3 = 値 / 値 = st.3 (lpoke/lpeek も可)
; Reserved : DWORD (+16, 16byte) varptr(st)+16 を基点に操作(16byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; FAX_RECEIVE サイズ: 48 バイト(x64)
dim st, 12 ; 4byte整数×12(構造体サイズ 48 / 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,上位
; ReceiverName : LPWSTR (+16, 8byte) qpoke st,16,値 / qpeek(st,16) ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; ReceiverNumber : LPWSTR (+24, 8byte) qpoke st,24,値 / qpeek(st,24) ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; Reserved : DWORD (+32, 16byte) varptr(st)+32 を基点に操作(16byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global FAX_RECEIVE
#field int SizeOfStruct
#field intptr FileName
#field intptr ReceiverName
#field intptr ReceiverNumber
#field int Reserved 4
#endstruct
stdim st, FAX_RECEIVE ; NSTRUCT 変数を確保
st->SizeOfStruct = 100
mes "SizeOfStruct=" + st->SizeOfStruct