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

GetStdHandle

関数
標準入力・出力・エラーの標準デバイスハンドルを取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

HANDLE GetStdHandle(
    STD_HANDLE nStdHandle
);

パラメーター

名前型方向説明
nStdHandleSTD_HANDLEin取得する標準デバイスを示す値(STD_INPUT_HANDLE/STD_OUTPUT_HANDLE/STD_ERROR_HANDLE)。

戻り値の型: HANDLE

公式ドキュメント

指定した標準デバイス (標準入力、標準出力、または標準エラー) のハンドルを取得します。

戻り値

関数が成功した場合、戻り値は指定したデバイスのハンドル、または以前の SetStdHandle の呼び出しによって設定されたリダイレクト済みのハンドルです。このハンドルは GENERIC_READ および GENERIC_WRITE のアクセス権を持ちます。ただし、アプリケーションが SetStdHandle を使用して、より小さいアクセス権で標準ハンドルを設定している場合は除きます。

ヒント

使用後にこのハンドルを CloseHandle で破棄する必要はありません。詳細については 解説 を参照してください。

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

対話型デスクトップ上で実行されるサービスなど、アプリケーションが標準ハンドルを関連付けておらず、かつリダイレクトもしていない場合、戻り値は NULL です。

解説(Remarks)

GetStdHandle が返すハンドルは、コンソールに対して読み取りまたは書き込みを行う必要があるアプリケーションで使用できます。コンソールが作成されると、標準入力ハンドルはそのコンソールの入力バッファーのハンドルとなり、標準出力ハンドルと標準エラーハンドルはそのコンソールのアクティブなスクリーンバッファーのハンドルとなります。これらのハンドルは、ReadFile 関数や WriteFile 関数、またはコンソールの入力バッファーやスクリーンバッファーにアクセスする任意のコンソール関数 (たとえば ReadConsoleInput、WriteConsole、GetConsoleScreenBufferInfo の各関数) で使用できます。

プロセスの標準ハンドルは SetStdHandle の呼び出しによってリダイレクトされることがあり、その場合 GetStdHandle はリダイレクト後のハンドルを返します。標準ハンドルがリダイレクトされている場合は、CreateFile 関数の呼び出しで CONIN$ を指定することで、コンソールの入力バッファーのハンドルを取得できます。同様に、CONOUT$ を指定すると、コンソールのアクティブなスクリーンバッファーのハンドルを取得できます。

main メソッドに入った時点でのプロセスの標準ハンドルは、アプリケーションのビルド時にリンカーへ渡された /SUBSYSTEM フラグの構成によって決まります。/SUBSYSTEM:CONSOLE を指定すると、親プロセスが継承によって標準ハンドルテーブルを既に設定していない場合に、オペレーティングシステムが起動時にコンソールセッションでハンドルを設定するよう要求します。これに対して /SUBSYSTEM:WINDOWS は、そのアプリケーションがコンソールを必要とせず、標準ハンドルを使用する可能性が低いことを意味します。ハンドルの継承の詳細については、STARTF_USESTDHANDLES のドキュメントを参照してください。

宣言したサブシステムの範囲を超えて動作するアプリケーションもあります。たとえば、/SUBSYSTEM:WINDOWS のアプリケーションが、ログ記録やデバッグのために標準ハンドルを確認または使用しながら、通常はグラフィカルユーザーインターフェイスで動作する場合があります。このようなアプリケーションでは、起動時に標準ハンドルの状態を慎重に調べ、必要に応じて AttachConsole、AllocConsole、FreeConsole を使用してコンソールを追加または削除する必要があります。

また、継承したハンドルの種類に応じて動作を変えるアプリケーションもあります。コンソール、パイプ、ファイルなどの種類の判別には、GetFileType を使用できます。

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

各言語での呼び出し定義

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

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

GetStdHandle = ctypes.windll.kernel32.GetStdHandle
GetStdHandle.restype = ctypes.c_void_p
GetStdHandle.argtypes = [
    wintypes.DWORD,  # nStdHandle : STD_HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetStdHandle = kernel32.NewProc("GetStdHandle")
)

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

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

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

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

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

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

関連項目

使用する型