Win32 API 日本語リファレンス
ホームSystem.Js › JsSetRuntimeBeforeCollectCallback

JsSetRuntimeBeforeCollectCallback

関数
ガベージコレクション前に呼ぶコールバックを設定する。
DLLchakra.dll呼出規約winapi

シグネチャ

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

JsErrorCode JsSetRuntimeBeforeCollectCallback(
    void* runtime,
    void* callbackState,   // optional
    JsBeforeCollectCallback beforeCollectCallback
);

パラメーター

名前方向説明
runtimevoid*inGC前コールバックを設定する対象のランタイムのハンドル。
callbackStatevoid*inoptionalコールバック呼び出し時に渡されるユーザー定義の状態ポインタ。NULL可。
beforeCollectCallbackJsBeforeCollectCallbackinガベージコレクション開始直前に呼ばれるコールバック関数。NULLで解除する。

戻り値の型: JsErrorCode

各言語での呼び出し定義

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

JsErrorCode JsSetRuntimeBeforeCollectCallback(
    void* runtime,
    void* callbackState,   // optional
    JsBeforeCollectCallback beforeCollectCallback
);
[DllImport("chakra.dll", ExactSpelling = true)]
static extern uint JsSetRuntimeBeforeCollectCallback(
    IntPtr runtime,   // void*
    IntPtr callbackState,   // void* optional
    IntPtr beforeCollectCallback   // JsBeforeCollectCallback
);
<DllImport("chakra.dll", ExactSpelling:=True)>
Public Shared Function JsSetRuntimeBeforeCollectCallback(
    runtime As IntPtr,   ' void*
    callbackState As IntPtr,   ' void* optional
    beforeCollectCallback As IntPtr   ' JsBeforeCollectCallback
) As UInteger
End Function
' runtime : void*
' callbackState : void* optional
' beforeCollectCallback : JsBeforeCollectCallback
Declare PtrSafe Function JsSetRuntimeBeforeCollectCallback Lib "chakra" ( _
    ByVal runtime As LongPtr, _
    ByVal callbackState As LongPtr, _
    ByVal beforeCollectCallback As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JsSetRuntimeBeforeCollectCallback = ctypes.windll.chakra.JsSetRuntimeBeforeCollectCallback
JsSetRuntimeBeforeCollectCallback.restype = wintypes.DWORD
JsSetRuntimeBeforeCollectCallback.argtypes = [
    ctypes.POINTER(None),  # runtime : void*
    ctypes.POINTER(None),  # callbackState : void* optional
    ctypes.c_void_p,  # beforeCollectCallback : JsBeforeCollectCallback
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('chakra.dll')
JsSetRuntimeBeforeCollectCallback = Fiddle::Function.new(
  lib['JsSetRuntimeBeforeCollectCallback'],
  [
    Fiddle::TYPE_VOIDP,  # runtime : void*
    Fiddle::TYPE_VOIDP,  # callbackState : void* optional
    Fiddle::TYPE_VOIDP,  # beforeCollectCallback : JsBeforeCollectCallback
  ],
  -Fiddle::TYPE_INT)
#[link(name = "chakra")]
extern "system" {
    fn JsSetRuntimeBeforeCollectCallback(
        runtime: *mut (),  // void*
        callbackState: *mut (),  // void* optional
        beforeCollectCallback: *const core::ffi::c_void  // JsBeforeCollectCallback
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("chakra.dll")]
public static extern uint JsSetRuntimeBeforeCollectCallback(IntPtr runtime, IntPtr callbackState, IntPtr beforeCollectCallback);
"@
$api = Add-Type -MemberDefinition $sig -Name 'chakra_JsSetRuntimeBeforeCollectCallback' -Namespace Win32 -PassThru
# $api::JsSetRuntimeBeforeCollectCallback(runtime, callbackState, beforeCollectCallback)
#uselib "chakra.dll"
#func global JsSetRuntimeBeforeCollectCallback "JsSetRuntimeBeforeCollectCallback" sptr, sptr, sptr
; JsSetRuntimeBeforeCollectCallback runtime, callbackState, beforeCollectCallback   ; 戻り値は stat
; runtime : void* -> "sptr"
; callbackState : void* optional -> "sptr"
; beforeCollectCallback : JsBeforeCollectCallback -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "chakra.dll"
#cfunc global JsSetRuntimeBeforeCollectCallback "JsSetRuntimeBeforeCollectCallback" sptr, sptr, sptr
; res = JsSetRuntimeBeforeCollectCallback(runtime, callbackState, beforeCollectCallback)
; runtime : void* -> "sptr"
; callbackState : void* optional -> "sptr"
; beforeCollectCallback : JsBeforeCollectCallback -> "sptr"
; JsErrorCode JsSetRuntimeBeforeCollectCallback(void* runtime, void* callbackState, JsBeforeCollectCallback beforeCollectCallback)
#uselib "chakra.dll"
#cfunc global JsSetRuntimeBeforeCollectCallback "JsSetRuntimeBeforeCollectCallback" intptr, intptr, intptr
; res = JsSetRuntimeBeforeCollectCallback(runtime, callbackState, beforeCollectCallback)
; runtime : void* -> "intptr"
; callbackState : void* optional -> "intptr"
; beforeCollectCallback : JsBeforeCollectCallback -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	chakra = windows.NewLazySystemDLL("chakra.dll")
	procJsSetRuntimeBeforeCollectCallback = chakra.NewProc("JsSetRuntimeBeforeCollectCallback")
)

// runtime (void*), callbackState (void* optional), beforeCollectCallback (JsBeforeCollectCallback)
r1, _, err := procJsSetRuntimeBeforeCollectCallback.Call(
	uintptr(runtime),
	uintptr(callbackState),
	uintptr(beforeCollectCallback),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // JsErrorCode
function JsSetRuntimeBeforeCollectCallback(
  runtime: Pointer;   // void*
  callbackState: Pointer;   // void* optional
  beforeCollectCallback: Pointer   // JsBeforeCollectCallback
): DWORD; stdcall;
  external 'chakra.dll' name 'JsSetRuntimeBeforeCollectCallback';
result := DllCall("chakra\JsSetRuntimeBeforeCollectCallback"
    , "Ptr", runtime   ; void*
    , "Ptr", callbackState   ; void* optional
    , "Ptr", beforeCollectCallback   ; JsBeforeCollectCallback
    , "UInt")   ; return: JsErrorCode
●JsSetRuntimeBeforeCollectCallback(runtime, callbackState, beforeCollectCallback) = DLL("chakra.dll", "dword JsSetRuntimeBeforeCollectCallback(void*, void*, void*)")
# 呼び出し: JsSetRuntimeBeforeCollectCallback(runtime, callbackState, beforeCollectCallback)
# runtime : void* -> "void*"
# callbackState : void* optional -> "void*"
# beforeCollectCallback : JsBeforeCollectCallback -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef JsSetRuntimeBeforeCollectCallbackNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef JsSetRuntimeBeforeCollectCallbackDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final JsSetRuntimeBeforeCollectCallback = DynamicLibrary.open('chakra.dll')
    .lookupFunction<JsSetRuntimeBeforeCollectCallbackNative, JsSetRuntimeBeforeCollectCallbackDart>('JsSetRuntimeBeforeCollectCallback');
// runtime : void* -> Pointer<Void>
// callbackState : void* optional -> Pointer<Void>
// beforeCollectCallback : JsBeforeCollectCallback -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JsSetRuntimeBeforeCollectCallback(
  runtime: Pointer;   // void*
  callbackState: Pointer;   // void* optional
  beforeCollectCallback: Pointer   // JsBeforeCollectCallback
): DWORD; stdcall;
  external 'chakra.dll' name 'JsSetRuntimeBeforeCollectCallback';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JsSetRuntimeBeforeCollectCallback"
  c_JsSetRuntimeBeforeCollectCallback :: Ptr () -> Ptr () -> Ptr () -> IO Word32
-- runtime : void* -> Ptr ()
-- callbackState : void* optional -> Ptr ()
-- beforeCollectCallback : JsBeforeCollectCallback -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jssetruntimebeforecollectcallback =
  foreign "JsSetRuntimeBeforeCollectCallback"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* runtime : void* -> (ptr void) *)
(* callbackState : void* optional -> (ptr void) *)
(* beforeCollectCallback : JsBeforeCollectCallback -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library chakra (t "chakra.dll"))
(cffi:use-foreign-library chakra)

(cffi:defcfun ("JsSetRuntimeBeforeCollectCallback" js-set-runtime-before-collect-callback :convention :stdcall) :uint32
  (runtime :pointer)   ; void*
  (callback-state :pointer)   ; void* optional
  (before-collect-callback :pointer))   ; JsBeforeCollectCallback
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JsSetRuntimeBeforeCollectCallback = Win32::API::More->new('chakra',
    'DWORD JsSetRuntimeBeforeCollectCallback(LPVOID runtime, LPVOID callbackState, LPVOID beforeCollectCallback)');
# my $ret = $JsSetRuntimeBeforeCollectCallback->Call($runtime, $callbackState, $beforeCollectCallback);
# runtime : void* -> LPVOID
# callbackState : void* optional -> LPVOID
# beforeCollectCallback : JsBeforeCollectCallback -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型