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

FAX_DEV_STATUS

構造体
サイズx64: 56 バイト / x86: 44 バイト

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

フィールド

フィールドサイズx64x86説明
SizeOfStructDWORD4+0+0FAX_DEV_STATUS 構造体のサイズをバイト単位で指定します。FaxDevReportStatus 関数に応答する前に、FSP はこのメンバーに sizeof(FAX_DEV_STATUS) を設定しなければなりません。
StatusIdDWORD4+4+4

ファクスの状態コードまたは値を指定します。これには、定義済みのファクス状態コード (後述)、TAPI の LINEERR_ 定数 エラー コードのいずれか、または FSP が定義する値を指定できます。状態識別子がプロバイダー定義の場合、FSP は StringId メンバーの値も指定しなければなりません。定義済みのファクス状態コードは次のとおりです。

意味
FS_INITIALIZING 呼び出しを初期化しています。
FS_DIALING FSP が呼び出しの数字をダイヤルしています。
FS_TRANSMITTING FSP がファクス文書を送信しています。
FS_RECEIVING FSP がファクス文書を受信しています。
FS_COMPLETED ファクス送信の呼び出しが完了しました。
FS_LINE_UNAVAILABLE デバイスが使用できないため、FSP は呼び出しを完了できません。
FS_BUSY FSP がビジー信号を受信しました。
FS_NO_ANSWER 受信側デバイスが応答しないため、FSP は呼び出しを完了できません。
FS_BAD_ADDRESS 宛先アドレスが無効なため、FSP は呼び出しを完了できません。
FS_NO_DIAL_TONE ダイヤル トーンを検出できないため、FSP は呼び出しを完了できません。
FS_DISCONNECTED 受信側デバイスによって呼び出しが切断されました。
FS_FATAL_ERROR 致命的なエラーが発生しました。
FS_NOT_FAX_CALL この呼び出しはデータ通信の呼び出しまたは音声通話です。
FS_CALL_DELAYED FSP がビジー信号を複数回受信しました。ダイヤルの制限があるため、プロバイダーは再試行できません。(一部の国/地域では、番号がビジーの場合の再試行回数が制限されています。)
FS_USER_ABORT FSP が送信を取り消しました。取り消しは FaxDevAbortOperation 関数の呼び出しによって発生する場合があります。FSP は、ファクス送信を取り消すための UI を提供することもできます。
FS_ANSWERED FSP は着信呼び出しに応答しましたが、まだ受信は開始していません。この状態は、その呼び出しがファクスの呼び出しではない可能性があることをファクス サービスに示します。
FS_CALL_BLACKLISTED 電話番号がブロックまたは予約されているため (たとえば 911 などの緊急番号への発信)、FSP は呼び出しを完了できません。

ファクス状態コード FS_BAD_ADDRESSFS_CALL_BLACKLISTEDFS_USER_ABORT では、再試行は行われません。ファクス状態コード FS_LINE_UNAVAILABLE は、サービスがデバイスとの接続を失ったために回線が使用できない場合 (TAPI が LINE_CLOSE を送信し、FSP が FS_LINE_UNAVAILABLE を報告した場合) に、直ちに再試行が行われます。この再試行は、デバイスがオンラインに復帰したことが検出されるかどうかによって決まります。その他のすべてのファクス状態コードでは、ファクス サービスが再試行を管理します。

StringIdDWORD4+8+8StatusId がプロバイダー定義である場合に、StatusId メンバーに対応する文字列リソース識別子を指定します。ファクス サービスは、FSP のイメージから文字列を読み込みます。StatusId にプロバイダー定義の状態コードまたは値が格納されている場合、このメンバーは必須です。StatusId に定義済みの状態コードまたは値が格納されている場合、このメンバーは無視されます。
PageCountDWORD4+12+12FSP が受信しているファクス送信のページ番号を指定します。ページ数は 1 から始まります。
CSILPWSTR8/4+16+16

FaxDevReceive 関数または FaxDevSend 関数への現在の呼び出しで接続されているリモート ファクス デバイスの識別子を指定する、NULL で終わる Unicode 文字列へのポインターです。

操作がファクスの送信である場合、識別子はリモート デバイスの CSID を指定します。操作がファクスの受信である場合、識別子はリモート デバイスの TSID を指定します。

CallerIdLPWSTR8/4+24+20受信したファクス文書を送信した発信側デバイスを識別する、NULL で終わる Unicode 文字列へのポインターです。この文字列には、発信側デバイスの電話番号を含めることができます。
RoutingInfoLPWSTR8/4+32+24

受信ファクスのルーティング文字列を指定する、NULL で終わる Unicode 文字列へのポインターです。この文字列は次の形式でなければなりません。

Canonical-Phone-Number[|Additional-Routing-Info]

ここで Canonical-Phone-Number は、TAPI ドキュメントの Address トピック (Canonical Address の副見出しを参照) で定義されています。Additional-Routing-Info は Canonical Address のサブアドレスであり、サブアドレスの形式を使用します。

DID ルーティングの場合は、電話番号のプレフィックスに固有の DID の数字を追加します。DID アドレスは、送信者がダイヤルしたであろう完全修飾電話番号に対応する正規の電話番号でなければなりません。

サブアドレスや DTMF トーンなどの追加のルーティング情報がある場合は、TAPI 仕様に示されているとおり、縦棒文字で正規の電話番号と区切ります。複数の受信者を指定できます。

詳細については、TAPI ドキュメントの Address トピックにある Dialable Address および Canonical Address の副見出しを参照してください。

ErrorCodeDWORD4+40+28発生したエラーを報告するために FSP が使用する、Win32 の システム エラー コード [Base] のいずれかを指定します。FSP は、実行中およびファクス ジョブが正常に完了した後は、この値に NO_ERROR を設定します。
ReservedDWORD12+44+32このメンバーは Microsoft によって予約済みです。0 に設定しなければなりません。

公式ドキュメント

FAX_DEV_STATUS 構造体は、個々のアクティブなファクス操作に関する状態情報と識別情報を格納します。

解説(Remarks)

FSP は、FAX_DEV_STATUS 構造体のすべてのメンバーに、アクティブなファクス操作の状態情報を設定するか、または 0 を設定しなければなりません。

ファクス サービスは、CSICallerIdRoutingInfo の各メンバーが指す文字列のためのメモリを割り当てます。サービスが割り当てるメモリのサイズは、sizeof(FAX_DEV_STATUS) + FAXDEVREPORTSTATUS_SIZE と等しくなります。FSP は、FAX_DEV_STATUS 構造体の直後に続くメモリ ブロック内に文字列を配置しなければなりません。CSICallerIdRoutingInfo の各メンバーは、メモリ ブロック内の文字列の位置を指していなければなりません。

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

各言語での定義

#include <windows.h>

// FAX_DEV_STATUS  (x64 56 / x86 44 バイト)
typedef struct FAX_DEV_STATUS {
    DWORD SizeOfStruct;
    DWORD StatusId;
    DWORD StringId;
    DWORD PageCount;
    LPWSTR CSI;
    LPWSTR CallerId;
    LPWSTR RoutingInfo;
    DWORD ErrorCode;
    DWORD Reserved[3];
} FAX_DEV_STATUS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FAX_DEV_STATUS
{
    public uint SizeOfStruct;
    public uint StatusId;
    public uint StringId;
    public uint PageCount;
    public IntPtr CSI;
    public IntPtr CallerId;
    public IntPtr RoutingInfo;
    public uint ErrorCode;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 3)] public uint[] Reserved;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure FAX_DEV_STATUS
    Public SizeOfStruct As UInteger
    Public StatusId As UInteger
    Public StringId As UInteger
    Public PageCount As UInteger
    Public CSI As IntPtr
    Public CallerId As IntPtr
    Public RoutingInfo As IntPtr
    Public ErrorCode As UInteger
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=3)> Public Reserved() As UInteger
End Structure
import ctypes
from ctypes import wintypes

class FAX_DEV_STATUS(ctypes.Structure):
    _fields_ = [
        ("SizeOfStruct", wintypes.DWORD),
        ("StatusId", wintypes.DWORD),
        ("StringId", wintypes.DWORD),
        ("PageCount", wintypes.DWORD),
        ("CSI", ctypes.c_void_p),
        ("CallerId", ctypes.c_void_p),
        ("RoutingInfo", ctypes.c_void_p),
        ("ErrorCode", wintypes.DWORD),
        ("Reserved", wintypes.DWORD * 3),
    ]
#[repr(C)]
pub struct FAX_DEV_STATUS {
    pub SizeOfStruct: u32,
    pub StatusId: u32,
    pub StringId: u32,
    pub PageCount: u32,
    pub CSI: *mut core::ffi::c_void,
    pub CallerId: *mut core::ffi::c_void,
    pub RoutingInfo: *mut core::ffi::c_void,
    pub ErrorCode: u32,
    pub Reserved: [u32; 3],
}
import "golang.org/x/sys/windows"

type FAX_DEV_STATUS struct {
	SizeOfStruct uint32
	StatusId uint32
	StringId uint32
	PageCount uint32
	CSI uintptr
	CallerId uintptr
	RoutingInfo uintptr
	ErrorCode uint32
	Reserved [3]uint32
}
type
  FAX_DEV_STATUS = record
    SizeOfStruct: DWORD;
    StatusId: DWORD;
    StringId: DWORD;
    PageCount: DWORD;
    CSI: Pointer;
    CallerId: Pointer;
    RoutingInfo: Pointer;
    ErrorCode: DWORD;
    Reserved: array[0..2] of DWORD;
  end;
const FAX_DEV_STATUS = extern struct {
    SizeOfStruct: u32,
    StatusId: u32,
    StringId: u32,
    PageCount: u32,
    CSI: ?*anyopaque,
    CallerId: ?*anyopaque,
    RoutingInfo: ?*anyopaque,
    ErrorCode: u32,
    Reserved: [3]u32,
};
type
  FAX_DEV_STATUS {.bycopy.} = object
    SizeOfStruct: uint32
    StatusId: uint32
    StringId: uint32
    PageCount: uint32
    CSI: pointer
    CallerId: pointer
    RoutingInfo: pointer
    ErrorCode: uint32
    Reserved: array[3, uint32]
struct FAX_DEV_STATUS
{
    uint SizeOfStruct;
    uint StatusId;
    uint StringId;
    uint PageCount;
    void* CSI;
    void* CallerId;
    void* RoutingInfo;
    uint ErrorCode;
    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_DEV_STATUS サイズ: 44 バイト(x86)
dim st, 11    ; 4byte整数×11(構造体サイズ 44 / 4 切り上げ)
; SizeOfStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; StatusId : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; StringId : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; PageCount : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; CSI : LPWSTR (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; CallerId : LPWSTR (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; RoutingInfo : LPWSTR (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; ErrorCode : 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_DEV_STATUS サイズ: 56 バイト(x64)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; SizeOfStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; StatusId : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; StringId : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; PageCount : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; CSI : LPWSTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; CallerId : LPWSTR (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; RoutingInfo : LPWSTR (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; ErrorCode : DWORD (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; Reserved : DWORD (+44, 12byte)  varptr(st)+44 を基点に操作(12byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global FAX_DEV_STATUS
    #field int SizeOfStruct
    #field int StatusId
    #field int StringId
    #field int PageCount
    #field intptr CSI
    #field intptr CallerId
    #field intptr RoutingInfo
    #field int ErrorCode
    #field int Reserved 3
#endstruct

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