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

TerminateReadLog

関数
CLFSログの読み取りカーソルコンテキストを終了する。
DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL TerminateReadLog(
    void* pvCursorContext
);

パラメーター

名前方向説明
pvCursorContextvoid*inoutReadLogRecord または ReadLogRestartArea によって返される読み取りコンテキストへのポインターです。

戻り値の型: BOOL

公式ドキュメント

読み取りコンテキストを終了します。この関数は、指定された読み取りコンテキストに関連付けられたシステム割り当てリソースを解放します。この関数を呼び出した後にログレコードを読み取ろうとしないでください。不定の結果が返されます。

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。次の一覧は、発生する可能性のあるエラーコードを示します。

解説(Remarks)

使用していない読み取りコンテキストを解放することは重要です。この関数を呼び出さないと、リソースリークが発生します。

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

各言語での呼び出し定義

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

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

TerminateReadLog = ctypes.windll.clfsw32.TerminateReadLog
TerminateReadLog.restype = wintypes.BOOL
TerminateReadLog.argtypes = [
    ctypes.POINTER(None),  # pvCursorContext : void* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procTerminateReadLog = clfsw32.NewProc("TerminateReadLog")
)

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

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

typedef TerminateReadLogNative = Int32 Function(Pointer<Void>);
typedef TerminateReadLogDart = int Function(Pointer<Void>);
final TerminateReadLog = DynamicLibrary.open('clfsw32.dll')
    .lookupFunction<TerminateReadLogNative, TerminateReadLogDart>('TerminateReadLog');
// pvCursorContext : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TerminateReadLog(
  pvCursorContext: Pointer   // void* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'TerminateReadLog';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TerminateReadLog"
  c_TerminateReadLog :: Ptr () -> IO CInt
-- pvCursorContext : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("TerminateReadLog" terminate-read-log :convention :stdcall) :int32
  (pv-cursor-context :pointer))   ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TerminateReadLog = Win32::API::More->new('clfsw32',
    'BOOL TerminateReadLog(LPVOID pvCursorContext)');
# my $ret = $TerminateReadLog->Call($pvCursorContext);
# pvCursorContext : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目