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

CreateConsoleScreenBuffer

関数
新しいコンソール画面バッファを作成しそのハンドルを返す。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HANDLE CreateConsoleScreenBuffer(
    DWORD dwDesiredAccess,
    DWORD dwShareMode,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    DWORD dwFlags,
    void* lpScreenBufferData   // optional
);

パラメーター

名前型方向説明
dwDesiredAccessDWORDinバッファへのアクセス権(GENERIC_READ/GENERIC_WRITE等)。
dwShareModeDWORDin共有モード(FILE_SHARE_READ/FILE_SHARE_WRITE)。
lpSecurityAttributesSECURITY_ATTRIBUTES*inoptionalハンドルの継承可否を指定するSECURITY_ATTRIBUTES構造体へのポインタ。NULL可。
dwFlagsDWORDinバッファ種別を示すフラグ。CONSOLE_TEXTMODE_BUFFERを指定する。
lpScreenBufferDatavoid*optional予約済みパラメータ。NULLを指定する。

戻り値の型: HANDLE

各言語での呼び出し定義

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

HANDLE CreateConsoleScreenBuffer(
    DWORD dwDesiredAccess,
    DWORD dwShareMode,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    DWORD dwFlags,
    void* lpScreenBufferData   // optional
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateConsoleScreenBuffer(
    uint dwDesiredAccess,   // DWORD
    uint dwShareMode,   // DWORD
    IntPtr lpSecurityAttributes,   // SECURITY_ATTRIBUTES* optional
    uint dwFlags,   // DWORD
    IntPtr lpScreenBufferData   // void* optional
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateConsoleScreenBuffer(
    dwDesiredAccess As UInteger,   ' DWORD
    dwShareMode As UInteger,   ' DWORD
    lpSecurityAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    dwFlags As UInteger,   ' DWORD
    lpScreenBufferData As IntPtr   ' void* optional
) As IntPtr
End Function
' dwDesiredAccess : DWORD
' dwShareMode : DWORD
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
' dwFlags : DWORD
' lpScreenBufferData : void* optional
Declare PtrSafe Function CreateConsoleScreenBuffer Lib "kernel32" ( _
    ByVal dwDesiredAccess As Long, _
    ByVal dwShareMode As Long, _
    ByVal lpSecurityAttributes As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lpScreenBufferData As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateConsoleScreenBuffer = ctypes.windll.kernel32.CreateConsoleScreenBuffer
CreateConsoleScreenBuffer.restype = ctypes.c_void_p
CreateConsoleScreenBuffer.argtypes = [
    wintypes.DWORD,  # dwDesiredAccess : DWORD
    wintypes.DWORD,  # dwShareMode : DWORD
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(None),  # lpScreenBufferData : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateConsoleScreenBuffer = Fiddle::Function.new(
  lib['CreateConsoleScreenBuffer'],
  [
    -Fiddle::TYPE_INT,  # dwDesiredAccess : DWORD
    -Fiddle::TYPE_INT,  # dwShareMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpScreenBufferData : void* optional
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn CreateConsoleScreenBuffer(
        dwDesiredAccess: u32,  // DWORD
        dwShareMode: u32,  // DWORD
        lpSecurityAttributes: *const SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        dwFlags: u32,  // DWORD
        lpScreenBufferData: *mut ()  // void* optional
    ) -> *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 CreateConsoleScreenBuffer(uint dwDesiredAccess, uint dwShareMode, IntPtr lpSecurityAttributes, uint dwFlags, IntPtr lpScreenBufferData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateConsoleScreenBuffer' -Namespace Win32 -PassThru
# $api::CreateConsoleScreenBuffer(dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwFlags, lpScreenBufferData)
#uselib "KERNEL32.dll"
#func global CreateConsoleScreenBuffer "CreateConsoleScreenBuffer" sptr, sptr, sptr, sptr, sptr
; CreateConsoleScreenBuffer dwDesiredAccess, dwShareMode, varptr(lpSecurityAttributes), dwFlags, lpScreenBufferData   ; 戻り値は stat
; dwDesiredAccess : DWORD -> "sptr"
; dwShareMode : DWORD -> "sptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; lpScreenBufferData : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global CreateConsoleScreenBuffer "CreateConsoleScreenBuffer" int, int, var, int, sptr
; res = CreateConsoleScreenBuffer(dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwFlags, lpScreenBufferData)
; dwDesiredAccess : DWORD -> "int"
; dwShareMode : DWORD -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; dwFlags : DWORD -> "int"
; lpScreenBufferData : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HANDLE CreateConsoleScreenBuffer(DWORD dwDesiredAccess, DWORD dwShareMode, SECURITY_ATTRIBUTES* lpSecurityAttributes, DWORD dwFlags, void* lpScreenBufferData)
#uselib "KERNEL32.dll"
#cfunc global CreateConsoleScreenBuffer "CreateConsoleScreenBuffer" int, int, var, int, intptr
; res = CreateConsoleScreenBuffer(dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwFlags, lpScreenBufferData)
; dwDesiredAccess : DWORD -> "int"
; dwShareMode : DWORD -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; dwFlags : DWORD -> "int"
; lpScreenBufferData : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateConsoleScreenBuffer = kernel32.NewProc("CreateConsoleScreenBuffer")
)

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

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

typedef CreateConsoleScreenBufferNative = Pointer<Void> Function(Uint32, Uint32, Pointer<Void>, Uint32, Pointer<Void>);
typedef CreateConsoleScreenBufferDart = Pointer<Void> Function(int, int, Pointer<Void>, int, Pointer<Void>);
final CreateConsoleScreenBuffer = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateConsoleScreenBufferNative, CreateConsoleScreenBufferDart>('CreateConsoleScreenBuffer');
// dwDesiredAccess : DWORD -> Uint32
// dwShareMode : DWORD -> Uint32
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// lpScreenBufferData : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateConsoleScreenBuffer(
  dwDesiredAccess: DWORD;   // DWORD
  dwShareMode: DWORD;   // DWORD
  lpSecurityAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  dwFlags: DWORD;   // DWORD
  lpScreenBufferData: Pointer   // void* optional
): THandle; stdcall;
  external 'KERNEL32.dll' name 'CreateConsoleScreenBuffer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateConsoleScreenBuffer"
  c_CreateConsoleScreenBuffer :: Word32 -> Word32 -> Ptr () -> Word32 -> Ptr () -> IO (Ptr ())
-- dwDesiredAccess : DWORD -> Word32
-- dwShareMode : DWORD -> Word32
-- lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- dwFlags : DWORD -> Word32
-- lpScreenBufferData : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createconsolescreenbuffer =
  foreign "CreateConsoleScreenBuffer"
    (uint32_t @-> uint32_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning (ptr void))
(* dwDesiredAccess : DWORD -> uint32_t *)
(* dwShareMode : DWORD -> uint32_t *)
(* lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* lpScreenBufferData : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateConsoleScreenBuffer" create-console-screen-buffer :convention :stdcall) :pointer
  (dw-desired-access :uint32)   ; DWORD
  (dw-share-mode :uint32)   ; DWORD
  (lp-security-attributes :pointer)   ; SECURITY_ATTRIBUTES* optional
  (dw-flags :uint32)   ; DWORD
  (lp-screen-buffer-data :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateConsoleScreenBuffer = Win32::API::More->new('KERNEL32',
    'HANDLE CreateConsoleScreenBuffer(DWORD dwDesiredAccess, DWORD dwShareMode, LPVOID lpSecurityAttributes, DWORD dwFlags, LPVOID lpScreenBufferData)');
# my $ret = $CreateConsoleScreenBuffer->Call($dwDesiredAccess, $dwShareMode, $lpSecurityAttributes, $dwFlags, $lpScreenBufferData);
# dwDesiredAccess : DWORD -> DWORD
# dwShareMode : DWORD -> DWORD
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# dwFlags : DWORD -> DWORD
# lpScreenBufferData : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型