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

GetConsoleOriginalTitleA

関数
コンソールの元のタイトル文字列を取得する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetConsoleOriginalTitleA(
    LPSTR lpConsoleTitle,
    DWORD nSize
);

パラメーター

名前方向説明
lpConsoleTitleLPSTRoutコンソール起動時の元のタイトルを受け取るANSIバッファへのポインタ。
nSizeDWORDinlpConsoleTitleバッファのサイズ(文字数)。

戻り値の型: DWORD

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetConsoleOriginalTitleA(
    LPSTR lpConsoleTitle,
    DWORD nSize
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetConsoleOriginalTitleA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpConsoleTitle,   // LPSTR out
    uint nSize   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetConsoleOriginalTitleA(
    <MarshalAs(UnmanagedType.LPStr)> lpConsoleTitle As System.Text.StringBuilder,   ' LPSTR out
    nSize As UInteger   ' DWORD
) As UInteger
End Function
' lpConsoleTitle : LPSTR out
' nSize : DWORD
Declare PtrSafe Function GetConsoleOriginalTitleA Lib "kernel32" ( _
    ByVal lpConsoleTitle As String, _
    ByVal nSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetConsoleOriginalTitleA = ctypes.windll.kernel32.GetConsoleOriginalTitleA
GetConsoleOriginalTitleA.restype = wintypes.DWORD
GetConsoleOriginalTitleA.argtypes = [
    wintypes.LPSTR,  # lpConsoleTitle : LPSTR out
    wintypes.DWORD,  # nSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetConsoleOriginalTitleA = Fiddle::Function.new(
  lib['GetConsoleOriginalTitleA'],
  [
    Fiddle::TYPE_VOIDP,  # lpConsoleTitle : LPSTR out
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetConsoleOriginalTitleA(
        lpConsoleTitle: *mut u8,  // LPSTR out
        nSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern uint GetConsoleOriginalTitleA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpConsoleTitle, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetConsoleOriginalTitleA' -Namespace Win32 -PassThru
# $api::GetConsoleOriginalTitleA(lpConsoleTitle, nSize)
#uselib "KERNEL32.dll"
#func global GetConsoleOriginalTitleA "GetConsoleOriginalTitleA" sptr, sptr
; GetConsoleOriginalTitleA varptr(lpConsoleTitle), nSize   ; 戻り値は stat
; lpConsoleTitle : LPSTR out -> "sptr"
; nSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetConsoleOriginalTitleA "GetConsoleOriginalTitleA" var, int
; res = GetConsoleOriginalTitleA(lpConsoleTitle, nSize)
; lpConsoleTitle : LPSTR out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetConsoleOriginalTitleA(LPSTR lpConsoleTitle, DWORD nSize)
#uselib "KERNEL32.dll"
#cfunc global GetConsoleOriginalTitleA "GetConsoleOriginalTitleA" var, int
; res = GetConsoleOriginalTitleA(lpConsoleTitle, nSize)
; lpConsoleTitle : LPSTR out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleOriginalTitleA = kernel32.NewProc("GetConsoleOriginalTitleA")
)

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

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

typedef GetConsoleOriginalTitleANative = Uint32 Function(Pointer<Utf8>, Uint32);
typedef GetConsoleOriginalTitleADart = int Function(Pointer<Utf8>, int);
final GetConsoleOriginalTitleA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetConsoleOriginalTitleANative, GetConsoleOriginalTitleADart>('GetConsoleOriginalTitleA');
// lpConsoleTitle : LPSTR out -> Pointer<Utf8>
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetConsoleOriginalTitleA(
  lpConsoleTitle: PAnsiChar;   // LPSTR out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetConsoleOriginalTitleA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetConsoleOriginalTitleA"
  c_GetConsoleOriginalTitleA :: CString -> Word32 -> IO Word32
-- lpConsoleTitle : LPSTR out -> CString
-- nSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getconsoleoriginaltitlea =
  foreign "GetConsoleOriginalTitleA"
    (string @-> uint32_t @-> returning uint32_t)
(* lpConsoleTitle : LPSTR out -> string *)
(* nSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetConsoleOriginalTitleA" get-console-original-title-a :convention :stdcall) :uint32
  (lp-console-title :pointer)   ; LPSTR out
  (n-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetConsoleOriginalTitleA = Win32::API::More->new('KERNEL32',
    'DWORD GetConsoleOriginalTitleA(LPSTR lpConsoleTitle, DWORD nSize)');
# my $ret = $GetConsoleOriginalTitleA->Call($lpConsoleTitle, $nSize);
# lpConsoleTitle : LPSTR out -> LPSTR
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い