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

GetLastError

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

シグネチャ

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

WIN32_ERROR GetLastError(void);

パラメーターなし。戻り値: WIN32_ERROR

公式ドキュメント

呼び出し元スレッドの最後のエラーコード値を取得します。

戻り値

戻り値は、呼び出し元スレッドの最後のエラーコードです。

最後のエラーコードを設定する各関数のドキュメントの「戻り値」セクションには、その関数が最後のエラーコードを設定する条件が記載されています。最後のエラーコードを設定するほとんどの関数は、失敗時にそれを設定します。ただし、一部の関数は成功時にも最後のエラーコードを設定します。関数が最後のエラーコードを設定するとドキュメントに記載されていない場合、この関数が返す値は、単に最後に設定された最新のエラーコードです。成功時に最後のエラーコードを 0 に設定する関数もあれば、そうしない関数もあります。

解説(Remarks)

呼び出し元スレッドが実行する関数は、SetLastError 関数を呼び出すことでこの値を設定します。関数の戻り値が、そのような呼び出しによって有用なデータが返されることを示している場合は、ただちに GetLastError 関数を呼び出す必要があります。これは、一部の関数が成功時にゼロを指定して SetLastError を呼び出し、直近に失敗した関数が設定したエラーコードを消去してしまうためです。

システムエラーコードに対応するエラー文字列を取得するには、FormatMessage 関数を使用します。オペレーティングシステムが提供するエラーコードの完全な一覧については、System Error Codes を参照してください。

関数が返すエラーコードは Windows API 仕様の一部ではなく、オペレーティングシステムやデバイスドライバーによって異なる場合があります。このため、各関数が返す可能性のあるエラーコードの完全な一覧を提供することはできません。また、返される可能性のあるエラーコードの部分的な一覧すらドキュメントに含まれていない関数も数多く存在します。

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

システムエラーを HRESULT 値に変換するには、HRESULT_FROM_WIN32 マクロを使用します。

Examples

例については、Retrieving the Last-Error Code を参照してください。

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

各言語での呼び出し定義

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

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

GetLastError = ctypes.windll.kernel32.GetLastError
GetLastError.restype = wintypes.DWORD
GetLastError.argtypes = []
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetLastError = Fiddle::Function.new(
  lib['GetLastError'],
  [],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetLastError() -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern uint GetLastError();
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetLastError' -Namespace Win32 -PassThru
# $api::GetLastError()
#uselib "KERNEL32.dll"
#func global GetLastError "GetLastError"
; GetLastError   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GetLastError "GetLastError"
; res = GetLastError()
; WIN32_ERROR GetLastError()
#uselib "KERNEL32.dll"
#cfunc global GetLastError "GetLastError"
; res = GetLastError()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetLastError = kernel32.NewProc("GetLastError")
)

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

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

typedef GetLastErrorNative = Uint32 Function();
typedef GetLastErrorDart = int Function();
final GetLastError = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetLastErrorNative, GetLastErrorDart>('GetLastError');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetLastError: DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetLastError';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

使用する型