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

GetConsoleAliasExesA

関数
エイリアスが登録されている実行ファイル名の一覧を取得する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

DWORD GetConsoleAliasExesA(
    LPSTR ExeNameBuffer,
    DWORD ExeNameBufferLength
);

パラメーター

名前方向説明
ExeNameBufferLPSTRoutエイリアスが登録されている全実行ファイル名を受け取るANSIバッファへのポインタ。
ExeNameBufferLengthDWORDinExeNameBufferのサイズ(バイト数)。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

GetConsoleAliasExesA = ctypes.windll.kernel32.GetConsoleAliasExesA
GetConsoleAliasExesA.restype = wintypes.DWORD
GetConsoleAliasExesA.argtypes = [
    wintypes.LPSTR,  # ExeNameBuffer : LPSTR out
    wintypes.DWORD,  # ExeNameBufferLength : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleAliasExesA = kernel32.NewProc("GetConsoleAliasExesA")
)

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

extern "kernel32" fn GetConsoleAliasExesA(
    ExeNameBuffer: [*c]u8, // LPSTR out
    ExeNameBufferLength: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc GetConsoleAliasExesA(
    ExeNameBuffer: ptr char,  # LPSTR out
    ExeNameBufferLength: uint32  # DWORD
): uint32 {.importc: "GetConsoleAliasExesA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint GetConsoleAliasExesA(
    char* ExeNameBuffer,   // LPSTR out
    uint ExeNameBufferLength   // DWORD
);
ccall((:GetConsoleAliasExesA, "KERNEL32.dll"), stdcall, UInt32,
      (Ptr{UInt8}, UInt32),
      ExeNameBuffer, ExeNameBufferLength)
# ExeNameBuffer : LPSTR out -> Ptr{UInt8}
# ExeNameBufferLength : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetConsoleAliasExesA(
    char* ExeNameBuffer,
    uint32_t ExeNameBufferLength);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetConsoleAliasExesA(ExeNameBuffer, ExeNameBufferLength)
-- ExeNameBuffer : LPSTR out
-- ExeNameBufferLength : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetConsoleAliasExesA = lib.func('__stdcall', 'GetConsoleAliasExesA', 'uint32_t', ['char *', 'uint32_t']);
// GetConsoleAliasExesA(ExeNameBuffer, ExeNameBufferLength)
// ExeNameBuffer : LPSTR out -> 'char *'
// ExeNameBufferLength : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetConsoleAliasExesA: { parameters: ["buffer", "u32"], result: "u32" },
});
// lib.symbols.GetConsoleAliasExesA(ExeNameBuffer, ExeNameBufferLength)
// ExeNameBuffer : LPSTR out -> "buffer"
// ExeNameBufferLength : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetConsoleAliasExesA(
    char* ExeNameBuffer,
    uint32_t ExeNameBufferLength);
C, "KERNEL32.dll");
// $ffi->GetConsoleAliasExesA(ExeNameBuffer, ExeNameBufferLength);
// ExeNameBuffer : LPSTR out
// ExeNameBufferLength : DWORD
// 構造体/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 GetConsoleAliasExesA(
        byte[] ExeNameBuffer,   // LPSTR out
        int ExeNameBufferLength   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetConsoleAliasExesA = GetConsoleAliasExesA(
    ExeNameBuffer : UInt8*,   # LPSTR out
    ExeNameBufferLength : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetConsoleAliasExesANative = Uint32 Function(Pointer<Utf8>, Uint32);
typedef GetConsoleAliasExesADart = int Function(Pointer<Utf8>, int);
final GetConsoleAliasExesA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetConsoleAliasExesANative, GetConsoleAliasExesADart>('GetConsoleAliasExesA');
// ExeNameBuffer : LPSTR out -> Pointer<Utf8>
// ExeNameBufferLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetConsoleAliasExesA(
  ExeNameBuffer: PAnsiChar;   // LPSTR out
  ExeNameBufferLength: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetConsoleAliasExesA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetConsoleAliasExesA"
  c_GetConsoleAliasExesA :: CString -> Word32 -> IO Word32
-- ExeNameBuffer : LPSTR out -> CString
-- ExeNameBufferLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getconsolealiasexesa =
  foreign "GetConsoleAliasExesA"
    (string @-> uint32_t @-> returning uint32_t)
(* ExeNameBuffer : LPSTR out -> string *)
(* ExeNameBufferLength : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetConsoleAliasExesA" get-console-alias-exes-a :convention :stdcall) :uint32
  (exe-name-buffer :pointer)   ; LPSTR out
  (exe-name-buffer-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetConsoleAliasExesA = Win32::API::More->new('KERNEL32',
    'DWORD GetConsoleAliasExesA(LPSTR ExeNameBuffer, DWORD ExeNameBufferLength)');
# my $ret = $GetConsoleAliasExesA->Call($ExeNameBuffer, $ExeNameBufferLength);
# ExeNameBuffer : LPSTR out -> LPSTR
# ExeNameBufferLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い