Win32 API 日本語リファレンス
ホームNetworkManagement.NetManagement › NetErrorLogClear

NetErrorLogClear

関数
サーバーのエラーログをクリアし任意でバックアップ保存する。
DLLNETAPI32.dll呼出規約winapi

シグネチャ

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

DWORD NetErrorLogClear(
    LPCWSTR UncServerName,   // optional
    LPCWSTR BackupFile,   // optional
    BYTE* Reserved   // optional
);

パラメーター

名前方向説明
UncServerNameLPCWSTRinoptional未定 (TBD)
BackupFileLPCWSTRinoptional未定 (TBD)
ReservedBYTE*inoptional未定 (TBD)

戻り値の型: DWORD

公式ドキュメント

NetErrorLogClear 関数は廃止されています。この関数は 16 ビット版 Windows との互換性のために含まれています。それ以外のアプリケーションではイベント ログを使用してください。

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

各言語での呼び出し定義

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

DWORD NetErrorLogClear(
    LPCWSTR UncServerName,   // optional
    LPCWSTR BackupFile,   // optional
    BYTE* Reserved   // optional
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetErrorLogClear(
    [MarshalAs(UnmanagedType.LPWStr)] string UncServerName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string BackupFile,   // LPCWSTR optional
    IntPtr Reserved   // BYTE* optional
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetErrorLogClear(
    <MarshalAs(UnmanagedType.LPWStr)> UncServerName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> BackupFile As String,   ' LPCWSTR optional
    Reserved As IntPtr   ' BYTE* optional
) As UInteger
End Function
' UncServerName : LPCWSTR optional
' BackupFile : LPCWSTR optional
' Reserved : BYTE* optional
Declare PtrSafe Function NetErrorLogClear Lib "netapi32" ( _
    ByVal UncServerName As LongPtr, _
    ByVal BackupFile As LongPtr, _
    ByVal Reserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NetErrorLogClear = ctypes.windll.netapi32.NetErrorLogClear
NetErrorLogClear.restype = wintypes.DWORD
NetErrorLogClear.argtypes = [
    wintypes.LPCWSTR,  # UncServerName : LPCWSTR optional
    wintypes.LPCWSTR,  # BackupFile : LPCWSTR optional
    ctypes.POINTER(ctypes.c_ubyte),  # Reserved : BYTE* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetErrorLogClear = Fiddle::Function.new(
  lib['NetErrorLogClear'],
  [
    Fiddle::TYPE_VOIDP,  # UncServerName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # BackupFile : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # Reserved : BYTE* optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetErrorLogClear(
        UncServerName: *const u16,  // LPCWSTR optional
        BackupFile: *const u16,  // LPCWSTR optional
        Reserved: *mut u8  // BYTE* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetErrorLogClear([MarshalAs(UnmanagedType.LPWStr)] string UncServerName, [MarshalAs(UnmanagedType.LPWStr)] string BackupFile, IntPtr Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetErrorLogClear' -Namespace Win32 -PassThru
# $api::NetErrorLogClear(UncServerName, BackupFile, Reserved)
#uselib "NETAPI32.dll"
#func global NetErrorLogClear "NetErrorLogClear" sptr, sptr, sptr
; NetErrorLogClear UncServerName, BackupFile, varptr(Reserved)   ; 戻り値は stat
; UncServerName : LPCWSTR optional -> "sptr"
; BackupFile : LPCWSTR optional -> "sptr"
; Reserved : BYTE* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NETAPI32.dll"
#cfunc global NetErrorLogClear "NetErrorLogClear" wstr, wstr, var
; res = NetErrorLogClear(UncServerName, BackupFile, Reserved)
; UncServerName : LPCWSTR optional -> "wstr"
; BackupFile : LPCWSTR optional -> "wstr"
; Reserved : BYTE* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD NetErrorLogClear(LPCWSTR UncServerName, LPCWSTR BackupFile, BYTE* Reserved)
#uselib "NETAPI32.dll"
#cfunc global NetErrorLogClear "NetErrorLogClear" wstr, wstr, var
; res = NetErrorLogClear(UncServerName, BackupFile, Reserved)
; UncServerName : LPCWSTR optional -> "wstr"
; BackupFile : LPCWSTR optional -> "wstr"
; Reserved : BYTE* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetErrorLogClear = netapi32.NewProc("NetErrorLogClear")
)

// UncServerName (LPCWSTR optional), BackupFile (LPCWSTR optional), Reserved (BYTE* optional)
r1, _, err := procNetErrorLogClear.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(UncServerName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(BackupFile))),
	uintptr(Reserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function NetErrorLogClear(
  UncServerName: PWideChar;   // LPCWSTR optional
  BackupFile: PWideChar;   // LPCWSTR optional
  Reserved: Pointer   // BYTE* optional
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetErrorLogClear';
result := DllCall("NETAPI32\NetErrorLogClear"
    , "WStr", UncServerName   ; LPCWSTR optional
    , "WStr", BackupFile   ; LPCWSTR optional
    , "Ptr", Reserved   ; BYTE* optional
    , "UInt")   ; return: DWORD
●NetErrorLogClear(UncServerName, BackupFile, Reserved) = DLL("NETAPI32.dll", "dword NetErrorLogClear(char*, char*, void*)")
# 呼び出し: NetErrorLogClear(UncServerName, BackupFile, Reserved)
# UncServerName : LPCWSTR optional -> "char*"
# BackupFile : LPCWSTR optional -> "char*"
# Reserved : BYTE* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "netapi32" fn NetErrorLogClear(
    UncServerName: [*c]const u16, // LPCWSTR optional
    BackupFile: [*c]const u16, // LPCWSTR optional
    Reserved: [*c]u8 // BYTE* optional
) callconv(std.os.windows.WINAPI) u32;
proc NetErrorLogClear(
    UncServerName: WideCString,  # LPCWSTR optional
    BackupFile: WideCString,  # LPCWSTR optional
    Reserved: ptr uint8  # BYTE* optional
): uint32 {.importc: "NetErrorLogClear", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetErrorLogClear(
    const(wchar)* UncServerName,   // LPCWSTR optional
    const(wchar)* BackupFile,   // LPCWSTR optional
    ubyte* Reserved   // BYTE* optional
);
ccall((:NetErrorLogClear, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, Ptr{UInt8}),
      UncServerName, BackupFile, Reserved)
# UncServerName : LPCWSTR optional -> Cwstring
# BackupFile : LPCWSTR optional -> Cwstring
# Reserved : BYTE* optional -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetErrorLogClear(
    const uint16_t* UncServerName,
    const uint16_t* BackupFile,
    uint8_t* Reserved);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetErrorLogClear(UncServerName, BackupFile, Reserved)
-- UncServerName : LPCWSTR optional
-- BackupFile : LPCWSTR optional
-- Reserved : BYTE* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetErrorLogClear = lib.func('__stdcall', 'NetErrorLogClear', 'uint32_t', ['str16', 'str16', 'uint8_t *']);
// NetErrorLogClear(UncServerName, BackupFile, Reserved)
// UncServerName : LPCWSTR optional -> 'str16'
// BackupFile : LPCWSTR optional -> 'str16'
// Reserved : BYTE* optional -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetErrorLogClear: { parameters: ["buffer", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.NetErrorLogClear(UncServerName, BackupFile, Reserved)
// UncServerName : LPCWSTR optional -> "buffer"
// BackupFile : LPCWSTR optional -> "buffer"
// Reserved : BYTE* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetErrorLogClear(
    const uint16_t* UncServerName,
    const uint16_t* BackupFile,
    uint8_t* Reserved);
C, "NETAPI32.dll");
// $ffi->NetErrorLogClear(UncServerName, BackupFile, Reserved);
// UncServerName : LPCWSTR optional
// BackupFile : LPCWSTR optional
// Reserved : BYTE* 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 Netapi32 extends StdCallLibrary {
    Netapi32 INSTANCE = Native.load("netapi32", Netapi32.class);
    int NetErrorLogClear(
        WString UncServerName,   // LPCWSTR optional
        WString BackupFile,   // LPCWSTR optional
        byte[] Reserved   // BYTE* optional
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetErrorLogClear = NetErrorLogClear(
    UncServerName : UInt16*,   # LPCWSTR optional
    BackupFile : UInt16*,   # LPCWSTR optional
    Reserved : UInt8*   # BYTE* optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NetErrorLogClearNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint8>);
typedef NetErrorLogClearDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint8>);
final NetErrorLogClear = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetErrorLogClearNative, NetErrorLogClearDart>('NetErrorLogClear');
// UncServerName : LPCWSTR optional -> Pointer<Utf16>
// BackupFile : LPCWSTR optional -> Pointer<Utf16>
// Reserved : BYTE* optional -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetErrorLogClear(
  UncServerName: PWideChar;   // LPCWSTR optional
  BackupFile: PWideChar;   // LPCWSTR optional
  Reserved: Pointer   // BYTE* optional
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetErrorLogClear';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetErrorLogClear"
  c_NetErrorLogClear :: CWString -> CWString -> Ptr Word8 -> IO Word32
-- UncServerName : LPCWSTR optional -> CWString
-- BackupFile : LPCWSTR optional -> CWString
-- Reserved : BYTE* optional -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let neterrorlogclear =
  foreign "NetErrorLogClear"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint8_t) @-> returning uint32_t)
(* UncServerName : LPCWSTR optional -> (ptr uint16_t) *)
(* BackupFile : LPCWSTR optional -> (ptr uint16_t) *)
(* Reserved : BYTE* optional -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetErrorLogClear" net-error-log-clear :convention :stdcall) :uint32
  (unc-server-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (backup-file (:string :encoding :utf-16le))   ; LPCWSTR optional
  (reserved :pointer))   ; BYTE* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetErrorLogClear = Win32::API::More->new('NETAPI32',
    'DWORD NetErrorLogClear(LPCWSTR UncServerName, LPCWSTR BackupFile, LPVOID Reserved)');
# my $ret = $NetErrorLogClear->Call($UncServerName, $BackupFile, $Reserved);
# UncServerName : LPCWSTR optional -> LPCWSTR
# BackupFile : LPCWSTR optional -> LPCWSTR
# Reserved : BYTE* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。