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

SetStdHandleEx

関数
標準デバイスハンドルを設定し、以前の値も取得する拡張関数。
DLLKERNEL32.dll呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL SetStdHandleEx(
    STD_HANDLE nStdHandle,
    HANDLE hHandle,
    HANDLE* phPrevValue   // optional
);

パラメーター

名前型方向説明
nStdHandleSTD_HANDLEin設定対象の標準デバイスを示す値(STD_INPUT_HANDLE等)。
hHandleHANDLEin標準デバイスに割り当てる新しいハンドル。
phPrevValueHANDLE*outoptional置き換え前のハンドルを受け取るHANDLEポインタ。不要ならNULL可。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetStdHandleEx(
    STD_HANDLE nStdHandle,
    HANDLE hHandle,
    HANDLE* phPrevValue   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool SetStdHandleEx(
    uint nStdHandle,   // STD_HANDLE
    IntPtr hHandle,   // HANDLE
    IntPtr phPrevValue   // HANDLE* optional, out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function SetStdHandleEx(
    nStdHandle As UInteger,   ' STD_HANDLE
    hHandle As IntPtr,   ' HANDLE
    phPrevValue As IntPtr   ' HANDLE* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' nStdHandle : STD_HANDLE
' hHandle : HANDLE
' phPrevValue : HANDLE* optional, out
Declare PtrSafe Function SetStdHandleEx Lib "kernel32" ( _
    ByVal nStdHandle As Long, _
    ByVal hHandle As LongPtr, _
    ByVal phPrevValue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetStdHandleEx = ctypes.windll.kernel32.SetStdHandleEx
SetStdHandleEx.restype = wintypes.BOOL
SetStdHandleEx.argtypes = [
    wintypes.DWORD,  # nStdHandle : STD_HANDLE
    wintypes.HANDLE,  # hHandle : HANDLE
    ctypes.c_void_p,  # phPrevValue : HANDLE* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetStdHandleEx = kernel32.NewProc("SetStdHandleEx")
)

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

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

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

foreign import stdcall safe "SetStdHandleEx"
  c_SetStdHandleEx :: Word32 -> Ptr () -> Ptr () -> IO CInt
-- nStdHandle : STD_HANDLE -> Word32
-- hHandle : HANDLE -> Ptr ()
-- phPrevValue : HANDLE* optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

類似 API
使用する型