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

FaxGetLoggingCategoriesA

関数
ファクスのログ記録カテゴリ設定を取得する。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL FaxGetLoggingCategoriesA(
    HANDLE FaxHandle,
    FAX_LOG_CATEGORYA** Categories,
    DWORD* NumberCategories
);

パラメーター

名前型方向説明
FaxHandleHANDLEinFAXサーバー接続のハンドルを指定する。
CategoriesFAX_LOG_CATEGORYA**outログカテゴリ情報配列(FAX_LOG_CATEGORYA)を受け取るポインタ。FaxFreeBufferで解放する。
NumberCategoriesDWORD*out返されたログカテゴリ数を受け取るDWORDへのポインタを指定する。出力専用。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

FaxGetLoggingCategoriesA = ctypes.windll.winfax.FaxGetLoggingCategoriesA
FaxGetLoggingCategoriesA.restype = wintypes.BOOL
FaxGetLoggingCategoriesA.argtypes = [
    wintypes.HANDLE,  # FaxHandle : HANDLE
    ctypes.c_void_p,  # Categories : FAX_LOG_CATEGORYA** out
    ctypes.POINTER(wintypes.DWORD),  # NumberCategories : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxGetLoggingCategoriesA = Fiddle::Function.new(
  lib['FaxGetLoggingCategoriesA'],
  [
    Fiddle::TYPE_VOIDP,  # FaxHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # Categories : FAX_LOG_CATEGORYA** out
    Fiddle::TYPE_VOIDP,  # NumberCategories : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winfax")]
extern "system" {
    fn FaxGetLoggingCategoriesA(
        FaxHandle: *mut core::ffi::c_void,  // HANDLE
        Categories: *mut *mut FAX_LOG_CATEGORYA,  // FAX_LOG_CATEGORYA** out
        NumberCategories: *mut u32  // DWORD* 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 FaxGetLoggingCategoriesA(IntPtr FaxHandle, IntPtr Categories, out uint NumberCategories);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxGetLoggingCategoriesA' -Namespace Win32 -PassThru
# $api::FaxGetLoggingCategoriesA(FaxHandle, Categories, NumberCategories)
#uselib "WINFAX.dll"
#func global FaxGetLoggingCategoriesA "FaxGetLoggingCategoriesA" sptr, sptr, sptr
; FaxGetLoggingCategoriesA FaxHandle, varptr(Categories), varptr(NumberCategories)   ; 戻り値は stat
; FaxHandle : HANDLE -> "sptr"
; Categories : FAX_LOG_CATEGORYA** out -> "sptr"
; NumberCategories : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "WINFAX.dll"
#cfunc global FaxGetLoggingCategoriesA "FaxGetLoggingCategoriesA" sptr, var, var
; res = FaxGetLoggingCategoriesA(FaxHandle, Categories, NumberCategories)
; FaxHandle : HANDLE -> "sptr"
; Categories : FAX_LOG_CATEGORYA** out -> "var"
; NumberCategories : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL FaxGetLoggingCategoriesA(HANDLE FaxHandle, FAX_LOG_CATEGORYA** Categories, DWORD* NumberCategories)
#uselib "WINFAX.dll"
#cfunc global FaxGetLoggingCategoriesA "FaxGetLoggingCategoriesA" intptr, var, var
; res = FaxGetLoggingCategoriesA(FaxHandle, Categories, NumberCategories)
; FaxHandle : HANDLE -> "intptr"
; Categories : FAX_LOG_CATEGORYA** out -> "var"
; NumberCategories : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxGetLoggingCategoriesA = winfax.NewProc("FaxGetLoggingCategoriesA")
)

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

extern "winfax" fn FaxGetLoggingCategoriesA(
    FaxHandle: ?*anyopaque, // HANDLE
    Categories: [*c][*c]FAX_LOG_CATEGORYA, // FAX_LOG_CATEGORYA** out
    NumberCategories: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc FaxGetLoggingCategoriesA(
    FaxHandle: pointer,  # HANDLE
    Categories: ptr FAX_LOG_CATEGORYA,  # FAX_LOG_CATEGORYA** out
    NumberCategories: ptr uint32  # DWORD* out
): int32 {.importc: "FaxGetLoggingCategoriesA", stdcall, dynlib: "WINFAX.dll".}
pragma(lib, "winfax");
extern(Windows)
int FaxGetLoggingCategoriesA(
    void* FaxHandle,   // HANDLE
    FAX_LOG_CATEGORYA** Categories,   // FAX_LOG_CATEGORYA** out
    uint* NumberCategories   // DWORD* out
);
ccall((:FaxGetLoggingCategoriesA, "WINFAX.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{FAX_LOG_CATEGORYA}, Ptr{UInt32}),
      FaxHandle, Categories, NumberCategories)
# FaxHandle : HANDLE -> Ptr{Cvoid}
# Categories : FAX_LOG_CATEGORYA** out -> Ptr{FAX_LOG_CATEGORYA}
# NumberCategories : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FaxGetLoggingCategoriesA(
    void* FaxHandle,
    void* Categories,
    uint32_t* NumberCategories);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxGetLoggingCategoriesA(FaxHandle, Categories, NumberCategories)
-- FaxHandle : HANDLE
-- Categories : FAX_LOG_CATEGORYA** out
-- NumberCategories : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxGetLoggingCategoriesA = lib.func('__stdcall', 'FaxGetLoggingCategoriesA', 'int32_t', ['void *', 'void *', 'uint32_t *']);
// FaxGetLoggingCategoriesA(FaxHandle, Categories, NumberCategories)
// FaxHandle : HANDLE -> 'void *'
// Categories : FAX_LOG_CATEGORYA** out -> 'void *'
// NumberCategories : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINFAX.dll", {
  FaxGetLoggingCategoriesA: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxGetLoggingCategoriesA(FaxHandle, Categories, NumberCategories)
// FaxHandle : HANDLE -> "pointer"
// Categories : FAX_LOG_CATEGORYA** out -> "pointer"
// NumberCategories : DWORD* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FaxGetLoggingCategoriesA(
    void* FaxHandle,
    void* Categories,
    uint32_t* NumberCategories);
C, "WINFAX.dll");
// $ffi->FaxGetLoggingCategoriesA(FaxHandle, Categories, NumberCategories);
// FaxHandle : HANDLE
// Categories : FAX_LOG_CATEGORYA** out
// NumberCategories : DWORD* 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 FaxGetLoggingCategoriesA(
        Pointer FaxHandle,   // HANDLE
        Pointer Categories,   // FAX_LOG_CATEGORYA** out
        IntByReference NumberCategories   // DWORD* out
    );
}
@[Link("winfax")]
lib LibWINFAX
  fun FaxGetLoggingCategoriesA = FaxGetLoggingCategoriesA(
    FaxHandle : Void*,   # HANDLE
    Categories : FAX_LOG_CATEGORYA**,   # FAX_LOG_CATEGORYA** out
    NumberCategories : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FaxGetLoggingCategoriesANative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef FaxGetLoggingCategoriesADart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final FaxGetLoggingCategoriesA = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxGetLoggingCategoriesANative, FaxGetLoggingCategoriesADart>('FaxGetLoggingCategoriesA');
// FaxHandle : HANDLE -> Pointer<Void>
// Categories : FAX_LOG_CATEGORYA** out -> Pointer<Void>
// NumberCategories : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxGetLoggingCategoriesA(
  FaxHandle: THandle;   // HANDLE
  Categories: Pointer;   // FAX_LOG_CATEGORYA** out
  NumberCategories: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxGetLoggingCategoriesA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxGetLoggingCategoriesA"
  c_FaxGetLoggingCategoriesA :: Ptr () -> Ptr () -> Ptr Word32 -> IO CInt
-- FaxHandle : HANDLE -> Ptr ()
-- Categories : FAX_LOG_CATEGORYA** out -> Ptr ()
-- NumberCategories : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxgetloggingcategoriesa =
  foreign "FaxGetLoggingCategoriesA"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* FaxHandle : HANDLE -> (ptr void) *)
(* Categories : FAX_LOG_CATEGORYA** out -> (ptr void) *)
(* NumberCategories : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winfax (t "WINFAX.dll"))
(cffi:use-foreign-library winfax)

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

関連項目

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