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

FaxSetLoggingCategoriesW

関数
ファクスのログ記録カテゴリ設定を変更する。
DLLWINFAX.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WINFAX.dll  (Unicode / -W)
#include <windows.h>

BOOL FaxSetLoggingCategoriesW(
    HANDLE FaxHandle,
    const FAX_LOG_CATEGORYW* Categories,
    DWORD NumberCategories
);

パラメーター

名前方向説明
FaxHandleHANDLEinFAXサーバー接続のハンドルを指定する。
CategoriesFAX_LOG_CATEGORYW*in設定するログカテゴリ情報配列(FAX_LOG_CATEGORYW)へのポインタを指定する。
NumberCategoriesDWORDinCategories配列の要素数を指定する。

戻り値の型: BOOL

各言語での呼び出し定義

// WINFAX.dll  (Unicode / -W)
#include <windows.h>

BOOL FaxSetLoggingCategoriesW(
    HANDLE FaxHandle,
    const FAX_LOG_CATEGORYW* Categories,
    DWORD NumberCategories
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FaxSetLoggingCategoriesW(
    IntPtr FaxHandle,   // HANDLE
    IntPtr Categories,   // FAX_LOG_CATEGORYW*
    uint NumberCategories   // DWORD
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxSetLoggingCategoriesW(
    FaxHandle As IntPtr,   ' HANDLE
    Categories As IntPtr,   ' FAX_LOG_CATEGORYW*
    NumberCategories As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FaxHandle : HANDLE
' Categories : FAX_LOG_CATEGORYW*
' NumberCategories : DWORD
Declare PtrSafe Function FaxSetLoggingCategoriesW Lib "winfax" ( _
    ByVal FaxHandle As LongPtr, _
    ByVal Categories As LongPtr, _
    ByVal NumberCategories As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxSetLoggingCategoriesW = winfax.NewProc("FaxSetLoggingCategoriesW")
)

// FaxHandle (HANDLE), Categories (FAX_LOG_CATEGORYW*), NumberCategories (DWORD)
r1, _, err := procFaxSetLoggingCategoriesW.Call(
	uintptr(FaxHandle),
	uintptr(Categories),
	uintptr(NumberCategories),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FaxSetLoggingCategoriesW(
  FaxHandle: THandle;   // HANDLE
  Categories: Pointer;   // FAX_LOG_CATEGORYW*
  NumberCategories: DWORD   // DWORD
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxSetLoggingCategoriesW';
result := DllCall("WINFAX\FaxSetLoggingCategoriesW"
    , "Ptr", FaxHandle   ; HANDLE
    , "Ptr", Categories   ; FAX_LOG_CATEGORYW*
    , "UInt", NumberCategories   ; DWORD
    , "Int")   ; return: BOOL
●FaxSetLoggingCategoriesW(FaxHandle, Categories, NumberCategories) = DLL("WINFAX.dll", "bool FaxSetLoggingCategoriesW(void*, void*, dword)")
# 呼び出し: FaxSetLoggingCategoriesW(FaxHandle, Categories, NumberCategories)
# FaxHandle : HANDLE -> "void*"
# Categories : FAX_LOG_CATEGORYW* -> "void*"
# NumberCategories : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

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

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

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

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

(cffi:defcfun ("FaxSetLoggingCategoriesW" fax-set-logging-categories-w :convention :stdcall) :int32
  (fax-handle :pointer)   ; HANDLE
  (categories :pointer)   ; FAX_LOG_CATEGORYW*
  (number-categories :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxSetLoggingCategoriesW = Win32::API::More->new('WINFAX',
    'BOOL FaxSetLoggingCategoriesW(HANDLE FaxHandle, LPVOID Categories, DWORD NumberCategories)');
# my $ret = $FaxSetLoggingCategoriesW->Call($FaxHandle, $Categories, $NumberCategories);
# FaxHandle : HANDLE -> HANDLE
# Categories : FAX_LOG_CATEGORYW* -> LPVOID
# NumberCategories : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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