Win32 API 日本語リファレンス
ホームFoundation › SetLastError

SetLastError

関数
呼び出しスレッドの最終エラーコードを設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

void SetLastError(
    WIN32_ERROR dwErrCode
);

パラメーター

名前方向説明
dwErrCodeWIN32_ERRORinスレッドの最終エラーコード。

戻り値の型: void

公式ドキュメント

呼び出し元スレッドの最終エラーコードを設定します。

解説(Remarks)

最終エラーコードはスレッドローカルストレージに保持されるため、複数のスレッドが互いの値を上書きすることはありません。

ほとんどの関数は、失敗した場合にのみ SetLastError または SetLastErrorEx を呼び出します。ただし、一部のシステム関数は成功した場合にも SetLastError または SetLastErrorEx を呼び出します。そのようなケースは各関数のドキュメントに記載されています。

アプリケーションは、関数が失敗した直後に GetLastError 関数を使用することで、この関数によって設定された値を取得できます。

エラーコードは 32 ビットの値です(ビット 31 が最上位ビットです)。ビット 29 はアプリケーション定義のエラーコード用に予約されており、システムエラーコードでこのビットが設定されているものはありません。アプリケーション用にエラーコードを定義する場合は、そのエラーコードがアプリケーションによって定義されたものであることを示し、システム定義のエラーコードと競合しないようにするために、このビットを設定してください。

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

各言語での呼び出し定義

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

void SetLastError(
    WIN32_ERROR dwErrCode
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern void SetLastError(
    uint dwErrCode   // WIN32_ERROR
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Sub SetLastError(
    dwErrCode As UInteger   ' WIN32_ERROR
)
End Sub
' dwErrCode : WIN32_ERROR
Declare PtrSafe Sub SetLastError Lib "kernel32" ( _
    ByVal dwErrCode As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetLastError = ctypes.windll.kernel32.SetLastError
SetLastError.restype = None
SetLastError.argtypes = [
    wintypes.DWORD,  # dwErrCode : WIN32_ERROR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetLastError = Fiddle::Function.new(
  lib['SetLastError'],
  [
    -Fiddle::TYPE_INT,  # dwErrCode : WIN32_ERROR
  ],
  Fiddle::TYPE_VOID)
#[link(name = "kernel32")]
extern "system" {
    fn SetLastError(
        dwErrCode: u32  // WIN32_ERROR
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern void SetLastError(uint dwErrCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetLastError' -Namespace Win32 -PassThru
# $api::SetLastError(dwErrCode)
#uselib "KERNEL32.dll"
#func global SetLastError "SetLastError" sptr
; SetLastError dwErrCode
; dwErrCode : WIN32_ERROR -> "sptr"
#uselib "KERNEL32.dll"
#func global SetLastError "SetLastError" int
; SetLastError dwErrCode
; dwErrCode : WIN32_ERROR -> "int"
; void SetLastError(WIN32_ERROR dwErrCode)
#uselib "KERNEL32.dll"
#func global SetLastError "SetLastError" int
; SetLastError dwErrCode
; dwErrCode : WIN32_ERROR -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetLastError = kernel32.NewProc("SetLastError")
)

// dwErrCode (WIN32_ERROR)
r1, _, err := procSetLastError.Call(
	uintptr(dwErrCode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure SetLastError(
  dwErrCode: DWORD   // WIN32_ERROR
); stdcall;
  external 'KERNEL32.dll' name 'SetLastError';
result := DllCall("KERNEL32\SetLastError"
    , "UInt", dwErrCode   ; WIN32_ERROR
    , "Int")   ; return: void
●SetLastError(dwErrCode) = DLL("KERNEL32.dll", "int SetLastError(dword)")
# 呼び出し: SetLastError(dwErrCode)
# dwErrCode : WIN32_ERROR -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetLastErrorNative = Void Function(Uint32);
typedef SetLastErrorDart = void Function(int);
final SetLastError = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetLastErrorNative, SetLastErrorDart>('SetLastError');
// dwErrCode : WIN32_ERROR -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure SetLastError(
  dwErrCode: DWORD   // WIN32_ERROR
); stdcall;
  external 'KERNEL32.dll' name 'SetLastError';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetLastError"
  c_SetLastError :: Word32 -> IO ()
-- dwErrCode : WIN32_ERROR -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setlasterror =
  foreign "SetLastError"
    (uint32_t @-> returning void)
(* dwErrCode : WIN32_ERROR -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetLastError" set-last-error :convention :stdcall) :void
  (dw-err-code :uint32))   ; WIN32_ERROR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetLastError = Win32::API::More->new('KERNEL32',
    'void SetLastError(DWORD dwErrCode)');
# my $ret = $SetLastError->Call($dwErrCode);
# dwErrCode : WIN32_ERROR -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型