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

SetConsoleActiveScreenBuffer

関数
指定した画面バッファをアクティブなコンソール画面に設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SetConsoleActiveScreenBuffer(
    HANDLE hConsoleOutput
);

パラメーター

名前方向説明
hConsoleOutputHANDLEinアクティブ(画面表示)にするコンソール画面バッファのハンドル。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetConsoleActiveScreenBuffer = ctypes.windll.kernel32.SetConsoleActiveScreenBuffer
SetConsoleActiveScreenBuffer.restype = wintypes.BOOL
SetConsoleActiveScreenBuffer.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetConsoleActiveScreenBuffer = kernel32.NewProc("SetConsoleActiveScreenBuffer")
)

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

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

typedef SetConsoleActiveScreenBufferNative = Int32 Function(Pointer<Void>);
typedef SetConsoleActiveScreenBufferDart = int Function(Pointer<Void>);
final SetConsoleActiveScreenBuffer = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetConsoleActiveScreenBufferNative, SetConsoleActiveScreenBufferDart>('SetConsoleActiveScreenBuffer');
// hConsoleOutput : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetConsoleActiveScreenBuffer(
  hConsoleOutput: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetConsoleActiveScreenBuffer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("SetConsoleActiveScreenBuffer" set-console-active-screen-buffer :convention :stdcall) :int32
  (h-console-output :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetConsoleActiveScreenBuffer = Win32::API::More->new('KERNEL32',
    'BOOL SetConsoleActiveScreenBuffer(HANDLE hConsoleOutput)');
# my $ret = $SetConsoleActiveScreenBuffer->Call($hConsoleOutput);
# hConsoleOutput : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。