ホーム › System.Console › GetConsoleAliasesA

GetConsoleAliasesA

関数

指定した実行ファイルに登録された全エイリアスを取得する(ANSI版)。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

DWORD GetConsoleAliasesA(
    LPSTR AliasBuffer,
    DWORD AliasBufferLength,
    LPSTR ExeName
);

パラメーター

名前	型	方向
AliasBuffer	LPSTR	out
AliasBufferLength	DWORD	in
ExeName	LPSTR	in

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetConsoleAliasesA(
    LPSTR AliasBuffer,
    DWORD AliasBufferLength,
    LPSTR ExeName
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetConsoleAliasesA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder AliasBuffer,   // LPSTR out
    uint AliasBufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string ExeName   // LPSTR
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetConsoleAliasesA(
    <MarshalAs(UnmanagedType.LPStr)> AliasBuffer As System.Text.StringBuilder,   ' LPSTR out
    AliasBufferLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> ExeName As String   ' LPSTR
) As UInteger
End Function

' AliasBuffer : LPSTR out
' AliasBufferLength : DWORD
' ExeName : LPSTR
Declare PtrSafe Function GetConsoleAliasesA Lib "kernel32" ( _
    ByVal AliasBuffer As String, _
    ByVal AliasBufferLength 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

GetConsoleAliasesA = ctypes.windll.kernel32.GetConsoleAliasesA
GetConsoleAliasesA.restype = wintypes.DWORD
GetConsoleAliasesA.argtypes = [
    wintypes.LPSTR,  # AliasBuffer : LPSTR out
    wintypes.DWORD,  # AliasBufferLength : 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')
GetConsoleAliasesA = Fiddle::Function.new(
  lib['GetConsoleAliasesA'],
  [
    Fiddle::TYPE_VOIDP,  # AliasBuffer : LPSTR out
    -Fiddle::TYPE_INT,  # AliasBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # ExeName : LPSTR
  ],
  -Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetConsoleAliasesA(
        AliasBuffer: *mut u8,  // LPSTR out
        AliasBufferLength: 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 GetConsoleAliasesA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder AliasBuffer, uint AliasBufferLength, [MarshalAs(UnmanagedType.LPStr)] string ExeName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetConsoleAliasesA' -Namespace Win32 -PassThru
# $api::GetConsoleAliasesA(AliasBuffer, AliasBufferLength, ExeName)

#uselib "KERNEL32.dll"
#func global GetConsoleAliasesA "GetConsoleAliasesA" sptr, sptr, sptr
; GetConsoleAliasesA varptr(AliasBuffer), AliasBufferLength, ExeName   ; 戻り値は stat
; AliasBuffer : LPSTR out -> "sptr"
; AliasBufferLength : DWORD -> "sptr"
; ExeName : LPSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetConsoleAliasesA "GetConsoleAliasesA" var, int, str
; res = GetConsoleAliasesA(AliasBuffer, AliasBufferLength, ExeName)
; AliasBuffer : LPSTR out -> "var"
; AliasBufferLength : DWORD -> "int"
; ExeName : LPSTR -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetConsoleAliasesA "GetConsoleAliasesA" sptr, int, str
; res = GetConsoleAliasesA(varptr(AliasBuffer), AliasBufferLength, ExeName)
; AliasBuffer : LPSTR out -> "sptr"
; AliasBufferLength : DWORD -> "int"
; ExeName : LPSTR -> "str"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD GetConsoleAliasesA(LPSTR AliasBuffer, DWORD AliasBufferLength, LPSTR ExeName)
#uselib "KERNEL32.dll"
#cfunc global GetConsoleAliasesA "GetConsoleAliasesA" var, int, str
; res = GetConsoleAliasesA(AliasBuffer, AliasBufferLength, ExeName)
; AliasBuffer : LPSTR out -> "var"
; AliasBufferLength : DWORD -> "int"
; ExeName : LPSTR -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD GetConsoleAliasesA(LPSTR AliasBuffer, DWORD AliasBufferLength, LPSTR ExeName)
#uselib "KERNEL32.dll"
#cfunc global GetConsoleAliasesA "GetConsoleAliasesA" intptr, int, str
; res = GetConsoleAliasesA(varptr(AliasBuffer), AliasBufferLength, ExeName)
; AliasBuffer : LPSTR out -> "intptr"
; AliasBufferLength : DWORD -> "int"
; ExeName : LPSTR -> "str"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleAliasesA = kernel32.NewProc("GetConsoleAliasesA")
)

// AliasBuffer (LPSTR out), AliasBufferLength (DWORD), ExeName (LPSTR)
r1, _, err := procGetConsoleAliasesA.Call(
	uintptr(AliasBuffer),
	uintptr(AliasBufferLength),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(ExeName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function GetConsoleAliasesA(
  AliasBuffer: PAnsiChar;   // LPSTR out
  AliasBufferLength: DWORD;   // DWORD
  ExeName: PAnsiChar   // LPSTR
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetConsoleAliasesA';

result := DllCall("KERNEL32\GetConsoleAliasesA"
    , "Ptr", AliasBuffer   ; LPSTR out
    , "UInt", AliasBufferLength   ; DWORD
    , "AStr", ExeName   ; LPSTR
    , "UInt")   ; return: DWORD

●GetConsoleAliasesA(AliasBuffer, AliasBufferLength, ExeName) = DLL("KERNEL32.dll", "dword GetConsoleAliasesA(char*, dword, char*)")
# 呼び出し: GetConsoleAliasesA(AliasBuffer, AliasBufferLength, ExeName)
# AliasBuffer : LPSTR out -> "char*"
# AliasBufferLength : DWORD -> "dword"
# ExeName : LPSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。