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エイリアスの展開先文字列を受け取るバッファへのポインタ。
TargetBufferLengthDWORDinTargetBufferのサイズ(バイト数)。
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 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn GetConsoleAliasW(
    Source: [*c]const u16, // LPWSTR
    TargetBuffer: [*c]u16, // LPWSTR out
    TargetBufferLength: u32, // DWORD
    ExeName: [*c]const u16 // LPWSTR
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetConsoleAliasW(
    Source: WideCString,  # LPWSTR
    TargetBuffer: ptr uint16,  # LPWSTR out
    TargetBufferLength: uint32,  # DWORD
    ExeName: WideCString  # LPWSTR
): uint32 {.importc: "GetConsoleAliasW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
uint GetConsoleAliasW(
    const(wchar)* Source,   // LPWSTR
    wchar* TargetBuffer,   // LPWSTR out
    uint TargetBufferLength,   // DWORD
    const(wchar)* ExeName   // LPWSTR
);
ccall((:GetConsoleAliasW, "KERNEL32.dll"), stdcall, UInt32,
      (Cwstring, Ptr{UInt16}, UInt32, Cwstring),
      Source, TargetBuffer, TargetBufferLength, ExeName)
# Source : LPWSTR -> Cwstring
# TargetBuffer : LPWSTR out -> Ptr{UInt16}
# TargetBufferLength : DWORD -> UInt32
# ExeName : LPWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetConsoleAliasW(
    const uint16_t* Source,
    uint16_t* TargetBuffer,
    uint32_t TargetBufferLength,
    const uint16_t* ExeName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetConsoleAliasW(Source, TargetBuffer, TargetBufferLength, ExeName)
-- Source : LPWSTR
-- TargetBuffer : LPWSTR out
-- TargetBufferLength : DWORD
-- ExeName : LPWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetConsoleAliasW = lib.func('__stdcall', 'GetConsoleAliasW', 'uint32_t', ['str16', 'uint16_t *', 'uint32_t', 'str16']);
// GetConsoleAliasW(Source, TargetBuffer, TargetBufferLength, ExeName)
// Source : LPWSTR -> 'str16'
// TargetBuffer : LPWSTR out -> 'uint16_t *'
// TargetBufferLength : DWORD -> 'uint32_t'
// ExeName : LPWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetConsoleAliasW: { parameters: ["buffer", "buffer", "u32", "buffer"], result: "u32" },
});
// lib.symbols.GetConsoleAliasW(Source, TargetBuffer, TargetBufferLength, ExeName)
// Source : LPWSTR -> "buffer"
// TargetBuffer : LPWSTR out -> "buffer"
// TargetBufferLength : DWORD -> "u32"
// ExeName : LPWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetConsoleAliasW(
    const uint16_t* Source,
    uint16_t* TargetBuffer,
    uint32_t TargetBufferLength,
    const uint16_t* ExeName);
C, "KERNEL32.dll");
// $ffi->GetConsoleAliasW(Source, TargetBuffer, TargetBufferLength, ExeName);
// Source : LPWSTR
// TargetBuffer : LPWSTR out
// TargetBufferLength : DWORD
// ExeName : LPWSTR
// 構造体/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.UNICODE_OPTIONS);
    int GetConsoleAliasW(
        WString Source,   // LPWSTR
        char[] TargetBuffer,   // LPWSTR out
        int TargetBufferLength,   // DWORD
        WString ExeName   // LPWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetConsoleAliasW = GetConsoleAliasW(
    Source : UInt16*,   # LPWSTR
    TargetBuffer : UInt16*,   # LPWSTR out
    TargetBufferLength : UInt32,   # DWORD
    ExeName : UInt16*   # LPWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetConsoleAliasWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Utf16>);
typedef GetConsoleAliasWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Utf16>);
final GetConsoleAliasW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetConsoleAliasWNative, GetConsoleAliasWDart>('GetConsoleAliasW');
// Source : LPWSTR -> Pointer<Utf16>
// TargetBuffer : LPWSTR out -> Pointer<Utf16>
// TargetBufferLength : DWORD -> Uint32
// ExeName : LPWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetConsoleAliasW(
  Source: PWideChar;   // LPWSTR
  TargetBuffer: PWideChar;   // LPWSTR out
  TargetBufferLength: DWORD;   // DWORD
  ExeName: PWideChar   // LPWSTR
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetConsoleAliasW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetConsoleAliasW"
  c_GetConsoleAliasW :: CWString -> CWString -> Word32 -> CWString -> IO Word32
-- Source : LPWSTR -> CWString
-- TargetBuffer : LPWSTR out -> CWString
-- TargetBufferLength : DWORD -> Word32
-- ExeName : LPWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getconsolealiasw =
  foreign "GetConsoleAliasW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint16_t) @-> returning uint32_t)
(* Source : LPWSTR -> (ptr uint16_t) *)
(* TargetBuffer : LPWSTR out -> (ptr uint16_t) *)
(* TargetBufferLength : DWORD -> uint32_t *)
(* ExeName : LPWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetConsoleAliasW" get-console-alias-w :convention :stdcall) :uint32
  (source (:string :encoding :utf-16le))   ; LPWSTR
  (target-buffer :pointer)   ; LPWSTR out
  (target-buffer-length :uint32)   ; DWORD
  (exe-name (:string :encoding :utf-16le)))   ; LPWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetConsoleAliasW = Win32::API::More->new('KERNEL32',
    'DWORD GetConsoleAliasW(LPCWSTR Source, LPWSTR TargetBuffer, DWORD TargetBufferLength, LPCWSTR ExeName)');
# my $ret = $GetConsoleAliasW->Call($Source, $TargetBuffer, $TargetBufferLength, $ExeName);
# Source : LPWSTR -> LPCWSTR
# TargetBuffer : LPWSTR out -> LPWSTR
# TargetBufferLength : DWORD -> DWORD
# ExeName : LPWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い