Win32 API 日本語リファレンス
ホームStorage.FileSystem › HandleLogFull

HandleLogFull

関数
CLFSログの満杯状態をクライアントが処理したことを通知する。
DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL HandleLogFull(
    HANDLE hLog
);

パラメーター

名前方向説明
hLogHANDLEinログフル状態を解決する対象のログへのハンドルです。このハンドルは RegisterManageableLogClient で登録されている必要があります。

戻り値の型: BOOL

公式ドキュメント

マネージドログクライアントが、ログへの予約または追加を試みた際にログフルエラーメッセージで失敗した場合に呼び出されます。ログマネージャーはクライアントのためにログフル状態の解決を試み、結果が判明した時点でクライアントに通知します。

戻り値

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

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

解説(Remarks)

ログフル状態を解決するためにコンテナーが作成される場合、それらは呼び出し元アプリケーションのセキュリティコンテキストを使用して作成されます。

HandleLogFull は常に非同期動作またはエラーを返します。false を返し、かつ GetLastErrorERROR_IO_PENDING を返す場合、結果は非同期動作となります。要求が非同期である場合、ハンドラーがログフル状態を解決したとき、または解決に失敗したときに、クライアントへ通知が送信されます。

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

各言語での呼び出し定義

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

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

HandleLogFull = ctypes.windll.clfsw32.HandleLogFull
HandleLogFull.restype = wintypes.BOOL
HandleLogFull.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
HandleLogFull = Fiddle::Function.new(
  lib['HandleLogFull'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "clfsw32")]
extern "system" {
    fn HandleLogFull(
        hLog: *mut core::ffi::c_void  // HANDLE
    ) -> 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 HandleLogFull(IntPtr hLog);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_HandleLogFull' -Namespace Win32 -PassThru
# $api::HandleLogFull(hLog)
#uselib "clfsw32.dll"
#func global HandleLogFull "HandleLogFull" sptr
; HandleLogFull hLog   ; 戻り値は stat
; hLog : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "clfsw32.dll"
#cfunc global HandleLogFull "HandleLogFull" sptr
; res = HandleLogFull(hLog)
; hLog : HANDLE -> "sptr"
; BOOL HandleLogFull(HANDLE hLog)
#uselib "clfsw32.dll"
#cfunc global HandleLogFull "HandleLogFull" intptr
; res = HandleLogFull(hLog)
; hLog : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procHandleLogFull = clfsw32.NewProc("HandleLogFull")
)

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

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

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

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

let handlelogfull =
  foreign "HandleLogFull"
    ((ptr void) @-> returning int32_t)
(* hLog : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clfsw32 (t "clfsw32.dll"))
(cffi:use-foreign-library clfsw32)

(cffi:defcfun ("HandleLogFull" handle-log-full :convention :stdcall) :int32
  (h-log :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HandleLogFull = Win32::API::More->new('clfsw32',
    'BOOL HandleLogFull(HANDLE hLog)');
# my $ret = $HandleLogFull->Call($hLog);
# hLog : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。