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

FAX_PORT_INFOA

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

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

フィールド

フィールドサイズx64x86説明
SizeOfStructDWORD4+0+0FAX_PORT_INFO 構造体のサイズをバイト単位で指定します。呼び出し側のアプリケーションは、FaxSetPort 関数を呼び出す前に、このメンバーに sizeof(FAX_PORT_INFO) が設定されていることを確認してください。
DeviceIdDWORD4+4+4対象のファックスデバイスの永続的な回線識別子を示す DWORD 変数を指定します。
StateDWORD4+8+8

ファックスデバイスの状態コードまたは値である DWORD 変数を指定します。このメンバーには、次に示す定義済みのデバイス状態コードのいずれかを指定できます。

FPS_DIALING

デバイスはファックス番号をダイヤルしています。

FPS_SENDING

デバイスはファックス文書を送信しています。

FPS_RECEIVING

デバイスはファックス文書を受信しています。

FPS_COMPLETED

デバイスはファックスの送信または受信を完了しました。

FPS_UNAVAILABLE

他のアプリケーションが使用中のため、デバイスは利用できません。

FPS_BUSY

デバイスは話中信号を検出しました。

FPS_NO_ANSWER

受信側のデバイスが呼び出しに応答しませんでした。

FPS_BAD_ADDRESS

デバイスは無効なファックス番号をダイヤルしました。

FPS_NO_DIAL_TONE

送信側のデバイスはダイヤルトーンを検出できないため、呼び出しを完了できません。

FPS_DISCONNECTED

ファックスの呼び出しが送信者または発信者によって切断されました。

FPS_FATAL_ERROR

デバイスで致命的なプロトコルエラーが発生しました。

FPS_NOT_FAX_CALL

デバイスはデータ呼び出しまたは音声呼び出しを受信しました。

FPS_CALL_DELAYED

送信側のデバイスが話中信号を複数回受信したため、デバイスはファックスの呼び出しを遅延させました。ダイヤルの制限があるため、デバイスは呼び出しを再試行できません。(一部の国/地域では、相手が話中の場合の再試行回数が制限されています。)

FPS_CALL_BLACKLISTED

電話番号がブロックまたは予約されているため、デバイスは呼び出しを完了できませんでした。911 などの緊急番号はブロックされています。

FPS_INITIALIZING

デバイスは呼び出しを初期化しています。

FPS_OFFLINE

デバイスはオフラインであり、利用できません。

FPS_RINGING

デバイスは呼び出し中です。

FPS_AVAILABLE

デバイスは利用可能です。

FPS_ABORTING

デバイスはファックスジョブを中止しています。

FPS_ROUTING

デバイスは受信したファックス文書をルーティングしています。

FPS_ANSWERED

デバイスは新しい呼び出しに応答しました。

FPS_HANDLED

ファックスサービスは送信ファックス文書を処理しました。ファックスサービスプロバイダーがこの文書を送信します。

FlagsDWORD4+12+12

ファックスポートの機能を指定するビットフラグのセットである DWORD 変数を指定します。このメンバーには、次の値の組み合わせを指定できます。

FPF_RECEIVE

デバイスはファックスを受信できます。

FPF_SEND

デバイスはファックスを送信できます。

FPF_VIRTUAL

デバイスは仮想ファックスデバイスです。詳細については、Virtual Fax Devices を参照してください。なお、デバイスを仮想に設定することはできません。FaxGetPort を呼び出した場合、FAX_PORT_INFO のフラグの FPF_VIRTUAL 値は、デバイスが仮想かどうかを示します。FaxSetPort を呼び出した場合、サービスは FPF_RECEIVEFPF_SEND の値のみを扱います。

RingsDWORD4+16+16指定したデバイスが着信したファックスの呼び出しに応答するまでに鳴らす呼び出し回数を示す DWORD 変数を指定します。指定できる値は 0 から 99 までです。この値は、FPF_RECEIVE のポート機能ビットフラグが設定されていない限り無視されます。
PriorityDWORD4+20+20

利用可能なファックスデバイスが送信を行う相対的な順序を決定する DWORD 変数を指定します。このメンバーの有効な値は 1 から n までです。ここで n は、FaxEnumPorts 関数の呼び出しによって返される PortsReturned パラメーターの値です。

ファックスサーバーは送信ファックスの伝送を開始する際、FPF_SEND のポート機能を持ち、優先度が最も高いデバイスを選択しようとします。そのデバイスが利用できない場合、サーバーは順位に従って次に利用可能なデバイスを選択し、以降も同様に処理します。Priority メンバーの値は、受信の伝送には影響しません。

DeviceNameLPSTR8/4+24+24対象のファックスデバイスの名前を指定する、null で終わる定数文字列へのポインターです。
TsidLPSTR8/4+32+28TSID を指定する、null で終わる定数文字列へのポインターです。この識別子は通常、電話番号です。TSID には、英字、数字記号、句読点などの印字可能な文字 (ASCII の 0x20 から 0x7F の範囲) のみを使用できます。
CsidLPSTR8/4+40+32着信側ステーション識別子 (CSID) を指定する、null で終わる定数文字列へのポインターです。この識別子は通常、電話番号です。CSID には、英字、数字記号、句読点などの印字可能な文字 (ASCII の 0x20 から 0x7F の範囲) のみを使用できます。

公式ドキュメント

FAX_PORT_INFO 構造体は、1 つのファックスポートを記述します。このデータには、デバイス識別子、ポートの名前と現在の状態、ステーション識別子などが含まれます。

解説(Remarks)

ファックスクライアントアプリケーションは、対象のファックスポートの構成を変更するために、FaxSetPort 関数の呼び出しで FAX_PORT_INFO 構造体を渡します。

アプリケーションが FaxEnumPorts 関数を呼び出して、現在ファックスサーバーに接続されているすべてのファックスデバイスを列挙すると、この関数は FAX_PORT_INFO 構造体の配列を返します。各構造体は 1 つのデバイスを詳細に記述します。アプリケーションが FaxGetPort 関数を呼び出して 1 つのデバイスを照会すると、この関数は 1 つの FAX_PORT_INFO 構造体でそのデバイスの情報を返します。詳細については、Fax Ports および Fax Device Management を参照してください。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして FAX_PORT_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_PORT_INFOA  (x64 48 / x86 36 バイト)
typedef struct FAX_PORT_INFOA {
    DWORD SizeOfStruct;
    DWORD DeviceId;
    DWORD State;
    DWORD Flags;
    DWORD Rings;
    DWORD Priority;
    LPSTR DeviceName;
    LPSTR Tsid;
    LPSTR Csid;
} FAX_PORT_INFOA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FAX_PORT_INFOA
{
    public uint SizeOfStruct;
    public uint DeviceId;
    public uint State;
    public uint Flags;
    public uint Rings;
    public uint Priority;
    public IntPtr DeviceName;
    public IntPtr Tsid;
    public IntPtr Csid;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure FAX_PORT_INFOA
    Public SizeOfStruct As UInteger
    Public DeviceId As UInteger
    Public State As UInteger
    Public Flags As UInteger
    Public Rings As UInteger
    Public Priority As UInteger
    Public DeviceName As IntPtr
    Public Tsid As IntPtr
    Public Csid As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class FAX_PORT_INFOA(ctypes.Structure):
    _fields_ = [
        ("SizeOfStruct", wintypes.DWORD),
        ("DeviceId", wintypes.DWORD),
        ("State", wintypes.DWORD),
        ("Flags", wintypes.DWORD),
        ("Rings", wintypes.DWORD),
        ("Priority", wintypes.DWORD),
        ("DeviceName", ctypes.c_void_p),
        ("Tsid", ctypes.c_void_p),
        ("Csid", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct FAX_PORT_INFOA {
    pub SizeOfStruct: u32,
    pub DeviceId: u32,
    pub State: u32,
    pub Flags: u32,
    pub Rings: u32,
    pub Priority: u32,
    pub DeviceName: *mut core::ffi::c_void,
    pub Tsid: *mut core::ffi::c_void,
    pub Csid: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type FAX_PORT_INFOA struct {
	SizeOfStruct uint32
	DeviceId uint32
	State uint32
	Flags uint32
	Rings uint32
	Priority uint32
	DeviceName uintptr
	Tsid uintptr
	Csid uintptr
}
type
  FAX_PORT_INFOA = record
    SizeOfStruct: DWORD;
    DeviceId: DWORD;
    State: DWORD;
    Flags: DWORD;
    Rings: DWORD;
    Priority: DWORD;
    DeviceName: Pointer;
    Tsid: Pointer;
    Csid: Pointer;
  end;
const FAX_PORT_INFOA = extern struct {
    SizeOfStruct: u32,
    DeviceId: u32,
    State: u32,
    Flags: u32,
    Rings: u32,
    Priority: u32,
    DeviceName: ?*anyopaque,
    Tsid: ?*anyopaque,
    Csid: ?*anyopaque,
};
type
  FAX_PORT_INFOA {.bycopy.} = object
    SizeOfStruct: uint32
    DeviceId: uint32
    State: uint32
    Flags: uint32
    Rings: uint32
    Priority: uint32
    DeviceName: pointer
    Tsid: pointer
    Csid: pointer
struct FAX_PORT_INFOA
{
    uint SizeOfStruct;
    uint DeviceId;
    uint State;
    uint Flags;
    uint Rings;
    uint Priority;
    void* DeviceName;
    void* Tsid;
    void* Csid;
}

HSP用 定義

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

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

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