ホーム › Storage.FileSystem › RegisterManageableLogClient

RegisterManageableLogClient

関数

CLFS管理可能ログクライアントのコールバックを登録する。

DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// clfsw32.dll
#include <windows.h>

BOOL RegisterManageableLogClient(
    HANDLE hLog,
    LOG_MANAGEMENT_CALLBACKS* pCallbacks
);

パラメーター

名前	型	方向	説明
hLog	HANDLE	in	登録するログのハンドル。ログの一意なオープンごとに登録は 1 回のみ許可されます。
pCallbacks	LOG_MANAGEMENT_CALLBACKS*	inout	クライアントが登録するコールバックを指定します。有効なコールバックは LOG_MANAGEMENT_CALLBACKS で列挙されています。通知をキューに格納する場合は 0 を指定します。

戻り値の型: BOOL

公式ドキュメント

クライアントをログマネージャーに登録します。クライアントは、コールバックを使用して通知を受け取るか、ReadLogNotification を使用して取得できるよう通知をキューに格納するかを指定できます。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

クライアントは、ログハンドルを閉じるか、DeregisterManageableLogClient を呼び出すことで登録を解除できます。

Examples

この関数を使用する例については、Creating a Log File を参照してください。

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

各言語での呼び出し定義

// clfsw32.dll
#include <windows.h>

BOOL RegisterManageableLogClient(
    HANDLE hLog,
    LOG_MANAGEMENT_CALLBACKS* pCallbacks
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool RegisterManageableLogClient(
    IntPtr hLog,   // HANDLE
    IntPtr pCallbacks   // LOG_MANAGEMENT_CALLBACKS* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RegisterManageableLogClient(
    hLog As IntPtr,   ' HANDLE
    pCallbacks As IntPtr   ' LOG_MANAGEMENT_CALLBACKS* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hLog : HANDLE
' pCallbacks : LOG_MANAGEMENT_CALLBACKS* in/out
Declare PtrSafe Function RegisterManageableLogClient Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal pCallbacks As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegisterManageableLogClient = ctypes.windll.clfsw32.RegisterManageableLogClient
RegisterManageableLogClient.restype = wintypes.BOOL
RegisterManageableLogClient.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    ctypes.c_void_p,  # pCallbacks : LOG_MANAGEMENT_CALLBACKS* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
RegisterManageableLogClient = Fiddle::Function.new(
  lib['RegisterManageableLogClient'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    Fiddle::TYPE_VOIDP,  # pCallbacks : LOG_MANAGEMENT_CALLBACKS* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn RegisterManageableLogClient(
        hLog: *mut core::ffi::c_void,  // HANDLE
        pCallbacks: *mut LOG_MANAGEMENT_CALLBACKS  // LOG_MANAGEMENT_CALLBACKS* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true)]
public static extern bool RegisterManageableLogClient(IntPtr hLog, IntPtr pCallbacks);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_RegisterManageableLogClient' -Namespace Win32 -PassThru
# $api::RegisterManageableLogClient(hLog, pCallbacks)

#uselib "clfsw32.dll"
#func global RegisterManageableLogClient "RegisterManageableLogClient" sptr, sptr
; RegisterManageableLogClient hLog, varptr(pCallbacks)   ; 戻り値は stat
; hLog : HANDLE -> "sptr"
; pCallbacks : LOG_MANAGEMENT_CALLBACKS* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "clfsw32.dll"
#cfunc global RegisterManageableLogClient "RegisterManageableLogClient" sptr, var
; res = RegisterManageableLogClient(hLog, pCallbacks)
; hLog : HANDLE -> "sptr"
; pCallbacks : LOG_MANAGEMENT_CALLBACKS* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "clfsw32.dll"
#cfunc global RegisterManageableLogClient "RegisterManageableLogClient" sptr, sptr
; res = RegisterManageableLogClient(hLog, varptr(pCallbacks))
; hLog : HANDLE -> "sptr"
; pCallbacks : LOG_MANAGEMENT_CALLBACKS* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。