ホーム › Storage.FileSystem › ReadLogNotification

ReadLogNotification

関数

CLFSログ管理通知を読み取る。

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

シグネチャ

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

BOOL ReadLogNotification(
    HANDLE hLog,
    CLFS_MGMT_NOTIFICATION* pNotification,
    OVERLAPPED* lpOverlapped
);

パラメーター

名前	型	方向	説明
hLog	HANDLE	in	ログのハンドルです。
pNotification	CLFS_MGMT_NOTIFICATION*	inout	通知の種類を受け取ります。その種類にパラメーターが関連付けられている場合は、それらのパラメーターも受け取ります。
lpOverlapped	OVERLAPPED*	inout	非同期操作に必要な OVERLAPPED 構造体へのポインターです。非同期操作を使用しない場合、このパラメーターは NULL にできます。

戻り値の型: BOOL

公式ドキュメント

ログマネージャーから通知を取得します。通知が利用可能な場合は、キューに格納された通知を即座に取得します。それ以外の場合は、通知が生成されるまで要求は保留状態のままになります。

戻り値

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

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。次のエラーコードが返される可能性があります:

解説(Remarks)

ログハンドルが FILE_FLAG_OVERLAPPED ファイルオプションを指定して作成されていない場合、ReadLogNotification の呼び出しが保留中の間は、そのログハンドルに対して操作を開始できません。

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

各言語での呼び出し定義

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

BOOL ReadLogNotification(
    HANDLE hLog,
    CLFS_MGMT_NOTIFICATION* pNotification,
    OVERLAPPED* lpOverlapped
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadLogNotification(
    IntPtr hLog,   // HANDLE
    IntPtr pNotification,   // CLFS_MGMT_NOTIFICATION* in/out
    IntPtr lpOverlapped   // OVERLAPPED* in/out
);

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

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

import ctypes
from ctypes import wintypes

ReadLogNotification = ctypes.windll.clfsw32.ReadLogNotification
ReadLogNotification.restype = wintypes.BOOL
ReadLogNotification.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    ctypes.c_void_p,  # pNotification : CLFS_MGMT_NOTIFICATION* in/out
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
ReadLogNotification = Fiddle::Function.new(
  lib['ReadLogNotification'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    Fiddle::TYPE_VOIDP,  # pNotification : CLFS_MGMT_NOTIFICATION* in/out
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn ReadLogNotification(
        hLog: *mut core::ffi::c_void,  // HANDLE
        pNotification: *mut CLFS_MGMT_NOTIFICATION,  // CLFS_MGMT_NOTIFICATION* in/out
        lpOverlapped: *mut OVERLAPPED  // OVERLAPPED* 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 ReadLogNotification(IntPtr hLog, IntPtr pNotification, IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_ReadLogNotification' -Namespace Win32 -PassThru
# $api::ReadLogNotification(hLog, pNotification, lpOverlapped)

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

出力引数:

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