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

GetConsoleAliasW

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

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetConsoleAliasW(
    LPWSTR Source,
    LPWSTR TargetBuffer,
    DWORD TargetBufferLength,
    LPWSTR ExeName
);

パラメーター

名前方向
SourceLPWSTRin
TargetBufferLPWSTRout
TargetBufferLengthDWORDin
ExeNameLPWSTRin

戻り値の型: DWORD

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetConsoleAliasW(
    LPWSTR Source,
    LPWSTR TargetBuffer,
    DWORD TargetBufferLength,
    LPWSTR ExeName
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetConsoleAliasW(
    [MarshalAs(UnmanagedType.LPWStr)] string Source,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder TargetBuffer,   // LPWSTR out
    uint TargetBufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string ExeName   // LPWSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetConsoleAliasW(
    <MarshalAs(UnmanagedType.LPWStr)> Source As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> TargetBuffer As System.Text.StringBuilder,   ' LPWSTR out
    TargetBufferLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> ExeName As String   ' LPWSTR
) As UInteger
End Function
' Source : LPWSTR
' TargetBuffer : LPWSTR out
' TargetBufferLength : DWORD
' ExeName : LPWSTR
Declare PtrSafe Function GetConsoleAliasW Lib "kernel32" ( _
    ByVal Source As LongPtr, _
    ByVal TargetBuffer As LongPtr, _
    ByVal TargetBufferLength As Long, _
    ByVal ExeName As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleAliasW = kernel32.NewProc("GetConsoleAliasW")
)

// Source (LPWSTR), TargetBuffer (LPWSTR out), TargetBufferLength (DWORD), ExeName (LPWSTR)
r1, _, err := procGetConsoleAliasW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Source))),
	uintptr(TargetBuffer),
	uintptr(TargetBufferLength),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ExeName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetConsoleAliasW(
  Source: PWideChar;   // LPWSTR
  TargetBuffer: PWideChar;   // LPWSTR out
  TargetBufferLength: DWORD;   // DWORD
  ExeName: PWideChar   // LPWSTR
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetConsoleAliasW';
result := DllCall("KERNEL32\GetConsoleAliasW"
    , "WStr", Source   ; LPWSTR
    , "Ptr", TargetBuffer   ; LPWSTR out
    , "UInt", TargetBufferLength   ; DWORD
    , "WStr", ExeName   ; LPWSTR
    , "UInt")   ; return: DWORD
●GetConsoleAliasW(Source, TargetBuffer, TargetBufferLength, ExeName) = DLL("KERNEL32.dll", "dword GetConsoleAliasW(char*, char*, dword, char*)")
# 呼び出し: GetConsoleAliasW(Source, TargetBuffer, TargetBufferLength, ExeName)
# Source : LPWSTR -> "char*"
# TargetBuffer : LPWSTR out -> "char*"
# TargetBufferLength : DWORD -> "dword"
# ExeName : LPWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。