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

FaxGetDeviceStatusA

関数
指定したファクスポートのデバイス状態情報を取得する。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WINFAX.dll  (ANSI / -A)
#include <windows.h>

BOOL FaxGetDeviceStatusA(
    HANDLE FaxPortHandle,
    FAX_DEVICE_STATUSA** DeviceStatus
);

パラメーター

名前方向説明
FaxPortHandleHANDLEin状態を取得する対象のFAXポートハンドルを指定する。
DeviceStatusFAX_DEVICE_STATUSA**outデバイス状態情報(FAX_DEVICE_STATUSA)を受け取るポインタ。FaxFreeBufferで解放する。

戻り値の型: BOOL

各言語での呼び出し定義

// WINFAX.dll  (ANSI / -A)
#include <windows.h>

BOOL FaxGetDeviceStatusA(
    HANDLE FaxPortHandle,
    FAX_DEVICE_STATUSA** DeviceStatus
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FaxGetDeviceStatusA(
    IntPtr FaxPortHandle,   // HANDLE
    IntPtr DeviceStatus   // FAX_DEVICE_STATUSA** out
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxGetDeviceStatusA(
    FaxPortHandle As IntPtr,   ' HANDLE
    DeviceStatus As IntPtr   ' FAX_DEVICE_STATUSA** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FaxPortHandle : HANDLE
' DeviceStatus : FAX_DEVICE_STATUSA** out
Declare PtrSafe Function FaxGetDeviceStatusA Lib "winfax" ( _
    ByVal FaxPortHandle As LongPtr, _
    ByVal DeviceStatus As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FaxGetDeviceStatusA = ctypes.windll.winfax.FaxGetDeviceStatusA
FaxGetDeviceStatusA.restype = wintypes.BOOL
FaxGetDeviceStatusA.argtypes = [
    wintypes.HANDLE,  # FaxPortHandle : HANDLE
    ctypes.c_void_p,  # DeviceStatus : FAX_DEVICE_STATUSA** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxGetDeviceStatusA = Fiddle::Function.new(
  lib['FaxGetDeviceStatusA'],
  [
    Fiddle::TYPE_VOIDP,  # FaxPortHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # DeviceStatus : FAX_DEVICE_STATUSA** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winfax")]
extern "system" {
    fn FaxGetDeviceStatusA(
        FaxPortHandle: *mut core::ffi::c_void,  // HANDLE
        DeviceStatus: *mut *mut FAX_DEVICE_STATUSA  // FAX_DEVICE_STATUSA** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool FaxGetDeviceStatusA(IntPtr FaxPortHandle, IntPtr DeviceStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxGetDeviceStatusA' -Namespace Win32 -PassThru
# $api::FaxGetDeviceStatusA(FaxPortHandle, DeviceStatus)
#uselib "WINFAX.dll"
#func global FaxGetDeviceStatusA "FaxGetDeviceStatusA" sptr, sptr
; FaxGetDeviceStatusA FaxPortHandle, varptr(DeviceStatus)   ; 戻り値は stat
; FaxPortHandle : HANDLE -> "sptr"
; DeviceStatus : FAX_DEVICE_STATUSA** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINFAX.dll"
#cfunc global FaxGetDeviceStatusA "FaxGetDeviceStatusA" sptr, var
; res = FaxGetDeviceStatusA(FaxPortHandle, DeviceStatus)
; FaxPortHandle : HANDLE -> "sptr"
; DeviceStatus : FAX_DEVICE_STATUSA** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FaxGetDeviceStatusA(HANDLE FaxPortHandle, FAX_DEVICE_STATUSA** DeviceStatus)
#uselib "WINFAX.dll"
#cfunc global FaxGetDeviceStatusA "FaxGetDeviceStatusA" intptr, var
; res = FaxGetDeviceStatusA(FaxPortHandle, DeviceStatus)
; FaxPortHandle : HANDLE -> "intptr"
; DeviceStatus : FAX_DEVICE_STATUSA** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxGetDeviceStatusA = winfax.NewProc("FaxGetDeviceStatusA")
)

// FaxPortHandle (HANDLE), DeviceStatus (FAX_DEVICE_STATUSA** out)
r1, _, err := procFaxGetDeviceStatusA.Call(
	uintptr(FaxPortHandle),
	uintptr(DeviceStatus),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FaxGetDeviceStatusA(
  FaxPortHandle: THandle;   // HANDLE
  DeviceStatus: Pointer   // FAX_DEVICE_STATUSA** out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxGetDeviceStatusA';
result := DllCall("WINFAX\FaxGetDeviceStatusA"
    , "Ptr", FaxPortHandle   ; HANDLE
    , "Ptr", DeviceStatus   ; FAX_DEVICE_STATUSA** out
    , "Int")   ; return: BOOL
●FaxGetDeviceStatusA(FaxPortHandle, DeviceStatus) = DLL("WINFAX.dll", "bool FaxGetDeviceStatusA(void*, void*)")
# 呼び出し: FaxGetDeviceStatusA(FaxPortHandle, DeviceStatus)
# FaxPortHandle : HANDLE -> "void*"
# DeviceStatus : FAX_DEVICE_STATUSA** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winfax" fn FaxGetDeviceStatusA(
    FaxPortHandle: ?*anyopaque, // HANDLE
    DeviceStatus: [*c][*c]FAX_DEVICE_STATUSA // FAX_DEVICE_STATUSA** out
) callconv(std.os.windows.WINAPI) i32;
proc FaxGetDeviceStatusA(
    FaxPortHandle: pointer,  # HANDLE
    DeviceStatus: ptr FAX_DEVICE_STATUSA  # FAX_DEVICE_STATUSA** out
): int32 {.importc: "FaxGetDeviceStatusA", stdcall, dynlib: "WINFAX.dll".}
pragma(lib, "winfax");
extern(Windows)
int FaxGetDeviceStatusA(
    void* FaxPortHandle,   // HANDLE
    FAX_DEVICE_STATUSA** DeviceStatus   // FAX_DEVICE_STATUSA** out
);
ccall((:FaxGetDeviceStatusA, "WINFAX.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{FAX_DEVICE_STATUSA}),
      FaxPortHandle, DeviceStatus)
# FaxPortHandle : HANDLE -> Ptr{Cvoid}
# DeviceStatus : FAX_DEVICE_STATUSA** out -> Ptr{FAX_DEVICE_STATUSA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FaxGetDeviceStatusA(
    void* FaxPortHandle,
    void* DeviceStatus);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxGetDeviceStatusA(FaxPortHandle, DeviceStatus)
-- FaxPortHandle : HANDLE
-- DeviceStatus : FAX_DEVICE_STATUSA** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxGetDeviceStatusA = lib.func('__stdcall', 'FaxGetDeviceStatusA', 'int32_t', ['void *', 'void *']);
// FaxGetDeviceStatusA(FaxPortHandle, DeviceStatus)
// FaxPortHandle : HANDLE -> 'void *'
// DeviceStatus : FAX_DEVICE_STATUSA** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINFAX.dll", {
  FaxGetDeviceStatusA: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxGetDeviceStatusA(FaxPortHandle, DeviceStatus)
// FaxPortHandle : HANDLE -> "pointer"
// DeviceStatus : FAX_DEVICE_STATUSA** out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FaxGetDeviceStatusA(
    void* FaxPortHandle,
    void* DeviceStatus);
C, "WINFAX.dll");
// $ffi->FaxGetDeviceStatusA(FaxPortHandle, DeviceStatus);
// FaxPortHandle : HANDLE
// DeviceStatus : FAX_DEVICE_STATUSA** out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Winfax extends StdCallLibrary {
    Winfax INSTANCE = Native.load("winfax", Winfax.class, W32APIOptions.ASCII_OPTIONS);
    boolean FaxGetDeviceStatusA(
        Pointer FaxPortHandle,   // HANDLE
        Pointer DeviceStatus   // FAX_DEVICE_STATUSA** out
    );
}
@[Link("winfax")]
lib LibWINFAX
  fun FaxGetDeviceStatusA = FaxGetDeviceStatusA(
    FaxPortHandle : Void*,   # HANDLE
    DeviceStatus : FAX_DEVICE_STATUSA**   # FAX_DEVICE_STATUSA** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FaxGetDeviceStatusANative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef FaxGetDeviceStatusADart = int Function(Pointer<Void>, Pointer<Void>);
final FaxGetDeviceStatusA = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxGetDeviceStatusANative, FaxGetDeviceStatusADart>('FaxGetDeviceStatusA');
// FaxPortHandle : HANDLE -> Pointer<Void>
// DeviceStatus : FAX_DEVICE_STATUSA** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxGetDeviceStatusA(
  FaxPortHandle: THandle;   // HANDLE
  DeviceStatus: Pointer   // FAX_DEVICE_STATUSA** out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxGetDeviceStatusA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxGetDeviceStatusA"
  c_FaxGetDeviceStatusA :: Ptr () -> Ptr () -> IO CInt
-- FaxPortHandle : HANDLE -> Ptr ()
-- DeviceStatus : FAX_DEVICE_STATUSA** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxgetdevicestatusa =
  foreign "FaxGetDeviceStatusA"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* FaxPortHandle : HANDLE -> (ptr void) *)
(* DeviceStatus : FAX_DEVICE_STATUSA** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winfax (t "WINFAX.dll"))
(cffi:use-foreign-library winfax)

(cffi:defcfun ("FaxGetDeviceStatusA" fax-get-device-status-a :convention :stdcall) :int32
  (fax-port-handle :pointer)   ; HANDLE
  (device-status :pointer))   ; FAX_DEVICE_STATUSA** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxGetDeviceStatusA = Win32::API::More->new('WINFAX',
    'BOOL FaxGetDeviceStatusA(HANDLE FaxPortHandle, LPVOID DeviceStatus)');
# my $ret = $FaxGetDeviceStatusA->Call($FaxPortHandle, $DeviceStatus);
# FaxPortHandle : HANDLE -> HANDLE
# DeviceStatus : FAX_DEVICE_STATUSA** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型