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

EvtOpenSession

関数
リモートイベントログ用のセッションを開く。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

EVT_HANDLE EvtOpenSession(
    EVT_LOGIN_CLASS LoginClass,
    void* Login,
    DWORD Timeout,   // optional
    DWORD Flags   // optional
);

パラメーター

名前方向説明
LoginClassEVT_LOGIN_CLASSinリモートコンピューターへの接続に使用する接続方法。指定可能な値については、EVT_LOGIN_CLASS 列挙型を参照してください。
Loginvoid*in接続先のリモートコンピューター、ユーザーの資格情報、および接続時に使用する認証の種類を識別する EVT_RPC_LOGIN 構造体です。
TimeoutDWORDoptional予約済み。ゼロを指定する必要があります。
FlagsDWORDoptional予約済み。ゼロを指定する必要があります。

戻り値の型: EVT_HANDLE

公式ドキュメント

他の Windows イベントログ関数を呼び出す際に使用できる、リモートコンピューターへの接続を確立します。

戻り値

成功した場合、関数はリモートコンピューター上のイベントログ情報へのアクセスに使用できるセッションハンドルを返します。それ以外の場合は NULL を返します。NULL の場合は、GetLastError 関数を呼び出してエラーコードを取得してください。

解説(Remarks)

セッションハンドルの使用が終了したら、EvtClose 関数を呼び出してください。セッションハンドルを閉じると、そのセッション内で作成されたすべての開いているハンドルも閉じられます(開いているハンドルを閉じると、それらのハンドルで現在実行中の処理はすべてキャンセルされます)。

リモートコンピューターに接続するには、リモートコンピューターで「リモートイベントログの管理」の Windows ファイアウォール例外を有効にする必要があります。そうでない場合、セッションハンドルを使用しようとすると、呼び出しは RPC_S_SERVER_UNAVAILABLE エラーになります。接続先のコンピューターは Windows Vista 以降を実行している必要があります。

この関数は資格情報を検証しません。資格情報は、セッションハンドルを最初に使用しようとしたときに検証されます。資格情報が無効な場合、呼び出しは ERROR_ACCESS_DENIED で失敗します。

使用例

この関数の使用方法を示す例については、Accessing Remote Computers を参照してください。

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

各言語での呼び出し定義

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

EVT_HANDLE EvtOpenSession(
    EVT_LOGIN_CLASS LoginClass,
    void* Login,
    DWORD Timeout,   // optional
    DWORD Flags   // optional
);
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr EvtOpenSession(
    int LoginClass,   // EVT_LOGIN_CLASS
    IntPtr Login,   // void*
    uint Timeout,   // DWORD optional
    uint Flags   // DWORD optional
);
<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtOpenSession(
    LoginClass As Integer,   ' EVT_LOGIN_CLASS
    Login As IntPtr,   ' void*
    Timeout As UInteger,   ' DWORD optional
    Flags As UInteger   ' DWORD optional
) As IntPtr
End Function
' LoginClass : EVT_LOGIN_CLASS
' Login : void*
' Timeout : DWORD optional
' Flags : DWORD optional
Declare PtrSafe Function EvtOpenSession Lib "wevtapi" ( _
    ByVal LoginClass As Long, _
    ByVal Login As LongPtr, _
    ByVal Timeout As Long, _
    ByVal Flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EvtOpenSession = ctypes.windll.wevtapi.EvtOpenSession
EvtOpenSession.restype = ctypes.c_ssize_t
EvtOpenSession.argtypes = [
    ctypes.c_int,  # LoginClass : EVT_LOGIN_CLASS
    ctypes.POINTER(None),  # Login : void*
    wintypes.DWORD,  # Timeout : DWORD optional
    wintypes.DWORD,  # Flags : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtOpenSession = Fiddle::Function.new(
  lib['EvtOpenSession'],
  [
    Fiddle::TYPE_INT,  # LoginClass : EVT_LOGIN_CLASS
    Fiddle::TYPE_VOIDP,  # Login : void*
    -Fiddle::TYPE_INT,  # Timeout : DWORD optional
    -Fiddle::TYPE_INT,  # Flags : DWORD optional
  ],
  Fiddle::TYPE_INTPTR_T)
#[link(name = "wevtapi")]
extern "system" {
    fn EvtOpenSession(
        LoginClass: i32,  // EVT_LOGIN_CLASS
        Login: *mut (),  // void*
        Timeout: u32,  // DWORD optional
        Flags: u32  // DWORD optional
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wevtapi.dll", SetLastError = true)]
public static extern IntPtr EvtOpenSession(int LoginClass, IntPtr Login, uint Timeout, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtOpenSession' -Namespace Win32 -PassThru
# $api::EvtOpenSession(LoginClass, Login, Timeout, Flags)
#uselib "wevtapi.dll"
#func global EvtOpenSession "EvtOpenSession" sptr, sptr, sptr, sptr
; EvtOpenSession LoginClass, Login, Timeout, Flags   ; 戻り値は stat
; LoginClass : EVT_LOGIN_CLASS -> "sptr"
; Login : void* -> "sptr"
; Timeout : DWORD optional -> "sptr"
; Flags : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "wevtapi.dll"
#cfunc global EvtOpenSession "EvtOpenSession" int, sptr, int, int
; res = EvtOpenSession(LoginClass, Login, Timeout, Flags)
; LoginClass : EVT_LOGIN_CLASS -> "int"
; Login : void* -> "sptr"
; Timeout : DWORD optional -> "int"
; Flags : DWORD optional -> "int"
; EVT_HANDLE EvtOpenSession(EVT_LOGIN_CLASS LoginClass, void* Login, DWORD Timeout, DWORD Flags)
#uselib "wevtapi.dll"
#cfunc global EvtOpenSession "EvtOpenSession" int, intptr, int, int
; res = EvtOpenSession(LoginClass, Login, Timeout, Flags)
; LoginClass : EVT_LOGIN_CLASS -> "int"
; Login : void* -> "intptr"
; Timeout : DWORD optional -> "int"
; Flags : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtOpenSession = wevtapi.NewProc("EvtOpenSession")
)

// LoginClass (EVT_LOGIN_CLASS), Login (void*), Timeout (DWORD optional), Flags (DWORD optional)
r1, _, err := procEvtOpenSession.Call(
	uintptr(LoginClass),
	uintptr(Login),
	uintptr(Timeout),
	uintptr(Flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // EVT_HANDLE
function EvtOpenSession(
  LoginClass: Integer;   // EVT_LOGIN_CLASS
  Login: Pointer;   // void*
  Timeout: DWORD;   // DWORD optional
  Flags: DWORD   // DWORD optional
): NativeInt; stdcall;
  external 'wevtapi.dll' name 'EvtOpenSession';
result := DllCall("wevtapi\EvtOpenSession"
    , "Int", LoginClass   ; EVT_LOGIN_CLASS
    , "Ptr", Login   ; void*
    , "UInt", Timeout   ; DWORD optional
    , "UInt", Flags   ; DWORD optional
    , "Ptr")   ; return: EVT_HANDLE
●EvtOpenSession(LoginClass, Login, Timeout, Flags) = DLL("wevtapi.dll", "int EvtOpenSession(int, void*, dword, dword)")
# 呼び出し: EvtOpenSession(LoginClass, Login, Timeout, Flags)
# LoginClass : EVT_LOGIN_CLASS -> "int"
# Login : void* -> "void*"
# Timeout : DWORD optional -> "dword"
# Flags : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef EvtOpenSessionNative = IntPtr Function(Int32, Pointer<Void>, Uint32, Uint32);
typedef EvtOpenSessionDart = int Function(int, Pointer<Void>, int, int);
final EvtOpenSession = DynamicLibrary.open('wevtapi.dll')
    .lookupFunction<EvtOpenSessionNative, EvtOpenSessionDart>('EvtOpenSession');
// LoginClass : EVT_LOGIN_CLASS -> Int32
// Login : void* -> Pointer<Void>
// Timeout : DWORD optional -> Uint32
// Flags : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EvtOpenSession(
  LoginClass: Integer;   // EVT_LOGIN_CLASS
  Login: Pointer;   // void*
  Timeout: DWORD;   // DWORD optional
  Flags: DWORD   // DWORD optional
): NativeInt; stdcall;
  external 'wevtapi.dll' name 'EvtOpenSession';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EvtOpenSession"
  c_EvtOpenSession :: Int32 -> Ptr () -> Word32 -> Word32 -> IO CIntPtr
-- LoginClass : EVT_LOGIN_CLASS -> Int32
-- Login : void* -> Ptr ()
-- Timeout : DWORD optional -> Word32
-- Flags : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let evtopensession =
  foreign "EvtOpenSession"
    (int32_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning intptr_t)
(* LoginClass : EVT_LOGIN_CLASS -> int32_t *)
(* Login : void* -> (ptr void) *)
(* Timeout : DWORD optional -> uint32_t *)
(* Flags : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wevtapi (t "wevtapi.dll"))
(cffi:use-foreign-library wevtapi)

(cffi:defcfun ("EvtOpenSession" evt-open-session :convention :stdcall) :int64
  (login-class :int32)   ; EVT_LOGIN_CLASS
  (login :pointer)   ; void*
  (timeout :uint32)   ; DWORD optional
  (flags :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EvtOpenSession = Win32::API::More->new('wevtapi',
    'LPARAM EvtOpenSession(int LoginClass, LPVOID Login, DWORD Timeout, DWORD Flags)');
# my $ret = $EvtOpenSession->Call($LoginClass, $Login, $Timeout, $Flags);
# LoginClass : EVT_LOGIN_CLASS -> int
# Login : void* -> LPVOID
# Timeout : DWORD optional -> DWORD
# Flags : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型