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

GetConsoleHistoryInfo

関数
コンソールのコマンド履歴に関する設定情報を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL GetConsoleHistoryInfo(
    CONSOLE_HISTORY_INFO* lpConsoleHistoryInfo
);

パラメーター

名前方向説明
lpConsoleHistoryInfoCONSOLE_HISTORY_INFO*outコマンド履歴のバッファサイズや件数等を受け取るCONSOLE_HISTORY_INFO出力ポインタ。cbSizeの設定が必要。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

GetConsoleHistoryInfo = ctypes.windll.kernel32.GetConsoleHistoryInfo
GetConsoleHistoryInfo.restype = wintypes.BOOL
GetConsoleHistoryInfo.argtypes = [
    ctypes.c_void_p,  # lpConsoleHistoryInfo : CONSOLE_HISTORY_INFO* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleHistoryInfo = kernel32.NewProc("GetConsoleHistoryInfo")
)

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

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

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

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

let getconsolehistoryinfo =
  foreign "GetConsoleHistoryInfo"
    ((ptr void) @-> returning int32_t)
(* lpConsoleHistoryInfo : CONSOLE_HISTORY_INFO* 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 ("GetConsoleHistoryInfo" get-console-history-info :convention :stdcall) :int32
  (lp-console-history-info :pointer))   ; CONSOLE_HISTORY_INFO* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetConsoleHistoryInfo = Win32::API::More->new('KERNEL32',
    'BOOL GetConsoleHistoryInfo(LPVOID lpConsoleHistoryInfo)');
# my $ret = $GetConsoleHistoryInfo->Call($lpConsoleHistoryInfo);
# lpConsoleHistoryInfo : CONSOLE_HISTORY_INFO* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型