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

GetCommandLineA

関数
呼び出し元プロセスのコマンドライン文字列を取得する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

LPSTR GetCommandLineA(void);

パラメーターなし。戻り値: LPSTR

公式ドキュメント

現在のプロセスのコマンドライン文字列を取得します。(ANSI)

戻り値

戻り値は、現在のプロセスのコマンドライン文字列へのポインターです。

解説(Remarks)

返される値の有効期間はシステムによって管理されます。アプリケーションはこの値を解放したり変更したりしないでください。

コンソールプロセスでは、main 関数または wmain 関数をプログラムのエントリポイントとして実装することで、それらの argc 引数および argv 引数を使用できます。

GUI プロセスでは、WinMain 関数または wWinMain 関数をプログラムのエントリポイントとして実装することで、その lpCmdLine 引数を使用できます。

コマンドラインを argv 形式の文字列配列に変換するには、GetCommandLineA の結果を CommandLineToArgvW に渡します。

メモ

オペレーティングシステムがプロセスに提供するコマンドライン内の実行可能ファイルの名前は、呼び出し元のプロセスが CreateProcessA 関数に渡したコマンドライン内の名前と必ずしも同一ではありません。オペレーティングシステムは、完全修飾パスなしで指定された実行可能ファイル名に、完全修飾パスを付加する場合があります。

セキュリティに関する解説

GetCommandLineA が返すコマンドラインは、Unicode のコマンドラインを 8 ビットのプロセスコードページに変換したものです。

ほとんどのコードページではこの変換は非可逆であり、変換後のコマンドラインは Unicode のコマンドラインと異なる場合があります。そのため、次のようなセキュリティ上の問題が生じる可能性があります。

この問題を回避するには、GetCommandLineW 関数を使用して Unicode のコマンドラインを受け取るか、アプリケーションマニフェストを使用して (Windows バージョン 1903 以降)、UTF-8 をプロセスコードページとして設定してください。

メモ

processenv.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、GetCommandLine を定義しています。エンコーディングに依存しないエイリアスの使用と、エンコーディングに依存するコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、「関数プロトタイプの規則」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

LPSTR GetCommandLineA(void);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr GetCommandLineA();
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetCommandLineA() As IntPtr
End Function
Declare PtrSafe Function GetCommandLineA Lib "kernel32" () As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetCommandLineA = ctypes.windll.kernel32.GetCommandLineA
GetCommandLineA.restype = wintypes.LPSTR
GetCommandLineA.argtypes = []
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetCommandLineA = Fiddle::Function.new(
  lib['GetCommandLineA'],
  [],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn GetCommandLineA() -> *mut u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr GetCommandLineA();
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetCommandLineA' -Namespace Win32 -PassThru
# $api::GetCommandLineA()
#uselib "KERNEL32.dll"
#func global GetCommandLineA "GetCommandLineA"
; GetCommandLineA   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GetCommandLineA "GetCommandLineA"
; res = GetCommandLineA()
; LPSTR GetCommandLineA()
#uselib "KERNEL32.dll"
#cfunc global GetCommandLineA "GetCommandLineA"
; res = GetCommandLineA()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetCommandLineA = kernel32.NewProc("GetCommandLineA")
)

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

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

typedef GetCommandLineANative = Pointer<Utf8> Function();
typedef GetCommandLineADart = Pointer<Utf8> Function();
final GetCommandLineA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetCommandLineANative, GetCommandLineADart>('GetCommandLineA');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetCommandLineA: PAnsiChar; stdcall;
  external 'KERNEL32.dll' name 'GetCommandLineA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetCommandLineA"
  c_GetCommandLineA :: IO CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("GetCommandLineA" get-command-line-a :convention :stdcall) :string)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetCommandLineA = Win32::API::More->new('KERNEL32',
    'LPSTR GetCommandLineA()');
# my $ret = $GetCommandLineA->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い