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

GetConsoleAliasA

関数
指定したソースに対応するコンソールエイリアスの内容を取得する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

DWORD GetConsoleAliasA(
    LPSTR Source,
    LPSTR TargetBuffer,
    DWORD TargetBufferLength,
    LPSTR ExeName
);

パラメーター

名前方向
SourceLPSTRin
TargetBufferLPSTRout
TargetBufferLengthDWORDin
ExeNameLPSTRin

戻り値の型: DWORD

各言語での呼び出し定義

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

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

GetConsoleAliasA = ctypes.windll.kernel32.GetConsoleAliasA
GetConsoleAliasA.restype = wintypes.DWORD
GetConsoleAliasA.argtypes = [
    wintypes.LPCSTR,  # Source : LPSTR
    wintypes.LPSTR,  # TargetBuffer : LPSTR out
    wintypes.DWORD,  # TargetBufferLength : DWORD
    wintypes.LPCSTR,  # ExeName : LPSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleAliasA = kernel32.NewProc("GetConsoleAliasA")
)

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