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

RegisterEventSourceA

関数
イベントソースを登録しハンドルを取得する(ANSI版)。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

HANDLE RegisterEventSourceA(
    LPCSTR lpUNCServerName,   // optional
    LPCSTR lpSourceName
);

パラメーター

名前型方向説明
lpUNCServerNameLPCSTRinoptionalこの操作を実行するリモートサーバーの UNC (Universal Naming Convention) 名。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。
lpSourceNameLPCSTRin

ハンドルを取得するイベントソースの名前。ソース名は、Eventlog レジストリキー配下にあるログのサブキーである必要があります。 なお、Security ログはシステム専用です。

Note この文字列には、XML 属性で使用が禁止されている文字を含めることはできません。ただし、&lt &gl などの XML エスケープシーケンスは例外です。

戻り値の型: HANDLE

公式ドキュメント

指定したイベントログへの登録済みハンドルを取得します。(ANSI)

戻り値

関数が成功した場合、戻り値はイベントログへのハンドルです。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

lpSourceName で Security イベントログを指定した場合、関数は ERROR_ACCESS_DENIED を返します。

解説(Remarks)

ソース名が見つからない場合、イベントログサービスは Application ログを使用します。イベントは報告されますが、イベント識別子に関連する説明を参照するためのメッセージファイルおよびカテゴリメッセージファイルが存在しないため、イベントに説明は含まれません。

イベントログへのハンドルを閉じるには、 DeregisterEventSource 関数を使用します。

Examples

例については、 Reporting an Event を参照してください。

メモ

winbase.h ヘッダーは RegisterEventSource をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスと、エンコーディング非依存でないコードを混在させて使用すると、不整合が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

HANDLE RegisterEventSourceA(
    LPCSTR lpUNCServerName,   // optional
    LPCSTR lpSourceName
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr RegisterEventSourceA(
    [MarshalAs(UnmanagedType.LPStr)] string lpUNCServerName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpSourceName   // LPCSTR
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RegisterEventSourceA(
    <MarshalAs(UnmanagedType.LPStr)> lpUNCServerName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpSourceName As String   ' LPCSTR
) As IntPtr
End Function
' lpUNCServerName : LPCSTR optional
' lpSourceName : LPCSTR
Declare PtrSafe Function RegisterEventSourceA Lib "advapi32" ( _
    ByVal lpUNCServerName As String, _
    ByVal lpSourceName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegisterEventSourceA = ctypes.windll.advapi32.RegisterEventSourceA
RegisterEventSourceA.restype = ctypes.c_void_p
RegisterEventSourceA.argtypes = [
    wintypes.LPCSTR,  # lpUNCServerName : LPCSTR optional
    wintypes.LPCSTR,  # lpSourceName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegisterEventSourceA = Fiddle::Function.new(
  lib['RegisterEventSourceA'],
  [
    Fiddle::TYPE_VOIDP,  # lpUNCServerName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpSourceName : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "advapi32")]
extern "system" {
    fn RegisterEventSourceA(
        lpUNCServerName: *const u8,  // LPCSTR optional
        lpSourceName: *const u8  // LPCSTR
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr RegisterEventSourceA([MarshalAs(UnmanagedType.LPStr)] string lpUNCServerName, [MarshalAs(UnmanagedType.LPStr)] string lpSourceName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegisterEventSourceA' -Namespace Win32 -PassThru
# $api::RegisterEventSourceA(lpUNCServerName, lpSourceName)
#uselib "ADVAPI32.dll"
#func global RegisterEventSourceA "RegisterEventSourceA" sptr, sptr
; RegisterEventSourceA lpUNCServerName, lpSourceName   ; 戻り値は stat
; lpUNCServerName : LPCSTR optional -> "sptr"
; lpSourceName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global RegisterEventSourceA "RegisterEventSourceA" str, str
; res = RegisterEventSourceA(lpUNCServerName, lpSourceName)
; lpUNCServerName : LPCSTR optional -> "str"
; lpSourceName : LPCSTR -> "str"
; HANDLE RegisterEventSourceA(LPCSTR lpUNCServerName, LPCSTR lpSourceName)
#uselib "ADVAPI32.dll"
#cfunc global RegisterEventSourceA "RegisterEventSourceA" str, str
; res = RegisterEventSourceA(lpUNCServerName, lpSourceName)
; lpUNCServerName : LPCSTR optional -> "str"
; lpSourceName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegisterEventSourceA = advapi32.NewProc("RegisterEventSourceA")
)

// lpUNCServerName (LPCSTR optional), lpSourceName (LPCSTR)
r1, _, err := procRegisterEventSourceA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpUNCServerName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpSourceName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function RegisterEventSourceA(
  lpUNCServerName: PAnsiChar;   // LPCSTR optional
  lpSourceName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'ADVAPI32.dll' name 'RegisterEventSourceA';
result := DllCall("ADVAPI32\RegisterEventSourceA"
    , "AStr", lpUNCServerName   ; LPCSTR optional
    , "AStr", lpSourceName   ; LPCSTR
    , "Ptr")   ; return: HANDLE
●RegisterEventSourceA(lpUNCServerName, lpSourceName) = DLL("ADVAPI32.dll", "void* RegisterEventSourceA(char*, char*)")
# 呼び出し: RegisterEventSourceA(lpUNCServerName, lpSourceName)
# lpUNCServerName : LPCSTR optional -> "char*"
# lpSourceName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn RegisterEventSourceA(
    lpUNCServerName: [*c]const u8, // LPCSTR optional
    lpSourceName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc RegisterEventSourceA(
    lpUNCServerName: cstring,  # LPCSTR optional
    lpSourceName: cstring  # LPCSTR
): pointer {.importc: "RegisterEventSourceA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
void* RegisterEventSourceA(
    const(char)* lpUNCServerName,   // LPCSTR optional
    const(char)* lpSourceName   // LPCSTR
);
ccall((:RegisterEventSourceA, "ADVAPI32.dll"), stdcall, Ptr{Cvoid},
      (Cstring, Cstring),
      lpUNCServerName, lpSourceName)
# lpUNCServerName : LPCSTR optional -> Cstring
# lpSourceName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* RegisterEventSourceA(
    const char* lpUNCServerName,
    const char* lpSourceName);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegisterEventSourceA(lpUNCServerName, lpSourceName)
-- lpUNCServerName : LPCSTR optional
-- lpSourceName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const RegisterEventSourceA = lib.func('__stdcall', 'RegisterEventSourceA', 'void *', ['str', 'str']);
// RegisterEventSourceA(lpUNCServerName, lpSourceName)
// lpUNCServerName : LPCSTR optional -> 'str'
// lpSourceName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  RegisterEventSourceA: { parameters: ["buffer", "buffer"], result: "pointer" },
});
// lib.symbols.RegisterEventSourceA(lpUNCServerName, lpSourceName)
// lpUNCServerName : LPCSTR optional -> "buffer"
// lpSourceName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* RegisterEventSourceA(
    const char* lpUNCServerName,
    const char* lpSourceName);
C, "ADVAPI32.dll");
// $ffi->RegisterEventSourceA(lpUNCServerName, lpSourceName);
// lpUNCServerName : LPCSTR optional
// lpSourceName : LPCSTR
// 構造体/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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.ASCII_OPTIONS);
    Pointer RegisterEventSourceA(
        String lpUNCServerName,   // LPCSTR optional
        String lpSourceName   // LPCSTR
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun RegisterEventSourceA = RegisterEventSourceA(
    lpUNCServerName : UInt8*,   # LPCSTR optional
    lpSourceName : UInt8*   # LPCSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RegisterEventSourceANative = Pointer<Void> Function(Pointer<Utf8>, Pointer<Utf8>);
typedef RegisterEventSourceADart = Pointer<Void> Function(Pointer<Utf8>, Pointer<Utf8>);
final RegisterEventSourceA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<RegisterEventSourceANative, RegisterEventSourceADart>('RegisterEventSourceA');
// lpUNCServerName : LPCSTR optional -> Pointer<Utf8>
// lpSourceName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegisterEventSourceA(
  lpUNCServerName: PAnsiChar;   // LPCSTR optional
  lpSourceName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'ADVAPI32.dll' name 'RegisterEventSourceA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegisterEventSourceA"
  c_RegisterEventSourceA :: CString -> CString -> IO (Ptr ())
-- lpUNCServerName : LPCSTR optional -> CString
-- lpSourceName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let registereventsourcea =
  foreign "RegisterEventSourceA"
    (string @-> string @-> returning (ptr void))
(* lpUNCServerName : LPCSTR optional -> string *)
(* lpSourceName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("RegisterEventSourceA" register-event-source-a :convention :stdcall) :pointer
  (lp-uncserver-name :string)   ; LPCSTR optional
  (lp-source-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegisterEventSourceA = Win32::API::More->new('ADVAPI32',
    'HANDLE RegisterEventSourceA(LPCSTR lpUNCServerName, LPCSTR lpSourceName)');
# my $ret = $RegisterEventSourceA->Call($lpUNCServerName, $lpSourceName);
# lpUNCServerName : LPCSTR optional -> LPCSTR
# lpSourceName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目