ホーム › System.Console › GetConsoleAliasA
GetConsoleAliasA
関数指定したソースに対応するコンソールエイリアスの内容を取得する(ANSI版)。
シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
DWORD GetConsoleAliasA(
LPSTR Source,
LPSTR TargetBuffer,
DWORD TargetBufferLength,
LPSTR ExeName
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Source | LPSTR | in | 値を取得するエイリアス名を格納したANSI文字列へのポインタ。 |
| TargetBuffer | LPSTR | out | エイリアスの展開先文字列を受け取るバッファへのポインタ。 |
| TargetBufferLength | DWORD | in | TargetBufferのサイズ(バイト数)。 |
| ExeName | LPSTR | in | エイリアスが属する実行ファイル名へのポインタ。 |
戻り値の型: 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 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global GetConsoleAliasA "GetConsoleAliasA" str, sptr, int, str ; res = GetConsoleAliasA(Source, varptr(TargetBuffer), TargetBufferLength, ExeName) ; Source : LPSTR -> "str" ; TargetBuffer : LPSTR out -> "sptr" ; TargetBufferLength : DWORD -> "int" ; ExeName : LPSTR -> "str" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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 方式にも切替可。; DWORD GetConsoleAliasA(LPSTR Source, LPSTR TargetBuffer, DWORD TargetBufferLength, LPSTR ExeName) #uselib "KERNEL32.dll" #cfunc global GetConsoleAliasA "GetConsoleAliasA" str, intptr, int, str ; res = GetConsoleAliasA(Source, varptr(TargetBuffer), TargetBufferLength, ExeName) ; Source : LPSTR -> "str" ; TargetBuffer : LPSTR out -> "intptr" ; TargetBufferLength : DWORD -> "int" ; ExeName : LPSTR -> "str" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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 // DWORDfunction 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)。const std = @import("std");
extern "kernel32" fn GetConsoleAliasA(
Source: [*c]const u8, // LPSTR
TargetBuffer: [*c]u8, // LPSTR out
TargetBufferLength: u32, // DWORD
ExeName: [*c]const u8 // LPSTR
) callconv(std.os.windows.WINAPI) u32;proc GetConsoleAliasA(
Source: cstring, # LPSTR
TargetBuffer: ptr char, # LPSTR out
TargetBufferLength: uint32, # DWORD
ExeName: cstring # LPSTR
): uint32 {.importc: "GetConsoleAliasA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
uint GetConsoleAliasA(
const(char)* Source, // LPSTR
char* TargetBuffer, // LPSTR out
uint TargetBufferLength, // DWORD
const(char)* ExeName // LPSTR
);ccall((:GetConsoleAliasA, "KERNEL32.dll"), stdcall, UInt32,
(Cstring, Ptr{UInt8}, UInt32, Cstring),
Source, TargetBuffer, TargetBufferLength, ExeName)
# Source : LPSTR -> Cstring
# TargetBuffer : LPSTR out -> Ptr{UInt8}
# TargetBufferLength : DWORD -> UInt32
# ExeName : LPSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t GetConsoleAliasA(
const char* Source,
char* TargetBuffer,
uint32_t TargetBufferLength,
const char* ExeName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetConsoleAliasA(Source, TargetBuffer, TargetBufferLength, ExeName)
-- Source : LPSTR
-- TargetBuffer : LPSTR out
-- TargetBufferLength : DWORD
-- ExeName : LPSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetConsoleAliasA = lib.func('__stdcall', 'GetConsoleAliasA', 'uint32_t', ['str', 'char *', 'uint32_t', 'str']);
// GetConsoleAliasA(Source, TargetBuffer, TargetBufferLength, ExeName)
// Source : LPSTR -> 'str'
// TargetBuffer : LPSTR out -> 'char *'
// TargetBufferLength : DWORD -> 'uint32_t'
// ExeName : LPSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GetConsoleAliasA: { parameters: ["buffer", "buffer", "u32", "buffer"], result: "u32" },
});
// lib.symbols.GetConsoleAliasA(Source, TargetBuffer, TargetBufferLength, ExeName)
// Source : LPSTR -> "buffer"
// TargetBuffer : LPSTR out -> "buffer"
// TargetBufferLength : DWORD -> "u32"
// ExeName : LPSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GetConsoleAliasA(
const char* Source,
char* TargetBuffer,
uint32_t TargetBufferLength,
const char* ExeName);
C, "KERNEL32.dll");
// $ffi->GetConsoleAliasA(Source, TargetBuffer, TargetBufferLength, ExeName);
// Source : LPSTR
// TargetBuffer : LPSTR out
// TargetBufferLength : DWORD
// ExeName : LPSTR
// 構造体/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 GetConsoleAliasA(
String Source, // LPSTR
byte[] TargetBuffer, // LPSTR out
int TargetBufferLength, // DWORD
String ExeName // LPSTR
);
}@[Link("kernel32")]
lib LibKERNEL32
fun GetConsoleAliasA = GetConsoleAliasA(
Source : UInt8*, # LPSTR
TargetBuffer : UInt8*, # LPSTR out
TargetBufferLength : UInt32, # DWORD
ExeName : UInt8* # LPSTR
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetConsoleAliasANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Utf8>);
typedef GetConsoleAliasADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Utf8>);
final GetConsoleAliasA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetConsoleAliasANative, GetConsoleAliasADart>('GetConsoleAliasA');
// Source : LPSTR -> Pointer<Utf8>
// TargetBuffer : LPSTR out -> Pointer<Utf8>
// TargetBufferLength : DWORD -> Uint32
// ExeName : LPSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetConsoleAliasA(
Source: PAnsiChar; // LPSTR
TargetBuffer: PAnsiChar; // LPSTR out
TargetBufferLength: DWORD; // DWORD
ExeName: PAnsiChar // LPSTR
): DWORD; stdcall;
external 'KERNEL32.dll' name 'GetConsoleAliasA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetConsoleAliasA"
c_GetConsoleAliasA :: CString -> CString -> Word32 -> CString -> IO Word32
-- Source : LPSTR -> CString
-- TargetBuffer : LPSTR out -> CString
-- TargetBufferLength : DWORD -> Word32
-- ExeName : LPSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getconsolealiasa =
foreign "GetConsoleAliasA"
(string @-> string @-> uint32_t @-> string @-> returning uint32_t)
(* Source : LPSTR -> string *)
(* TargetBuffer : LPSTR out -> string *)
(* TargetBufferLength : DWORD -> uint32_t *)
(* ExeName : LPSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("GetConsoleAliasA" get-console-alias-a :convention :stdcall) :uint32
(source :string) ; LPSTR
(target-buffer :pointer) ; LPSTR out
(target-buffer-length :uint32) ; DWORD
(exe-name :string)) ; LPSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetConsoleAliasA = Win32::API::More->new('KERNEL32',
'DWORD GetConsoleAliasA(LPCSTR Source, LPSTR TargetBuffer, DWORD TargetBufferLength, LPCSTR ExeName)');
# my $ret = $GetConsoleAliasA->Call($Source, $TargetBuffer, $TargetBufferLength, $ExeName);
# Source : LPSTR -> LPCSTR
# TargetBuffer : LPSTR out -> LPSTR
# TargetBufferLength : DWORD -> DWORD
# ExeName : LPSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f GetConsoleAliasW (Unicode版) — 指定したソースに対応するコンソールエイリアスの内容を取得する(Unicode版)。