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

GetCommandLineW

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

シグネチャ

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

LPWSTR GetCommandLineW(void);

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

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

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

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

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

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  (Unicode / -W)
#include <windows.h>

LPWSTR GetCommandLineW(void);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr GetCommandLineW();
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetCommandLineW() As IntPtr
End Function
Declare PtrSafe Function GetCommandLineW Lib "kernel32" () As LongPtr
' 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

GetCommandLineW = ctypes.windll.kernel32.GetCommandLineW
GetCommandLineW.restype = wintypes.LPWSTR
GetCommandLineW.argtypes = []
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetCommandLineW = kernel32.NewProc("GetCommandLineW")
)

r1, _, err := procGetCommandLineW.Call()
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LPWSTR
function GetCommandLineW: PWideChar; stdcall;
  external 'KERNEL32.dll' name 'GetCommandLineW';
result := DllCall("KERNEL32\GetCommandLineW", "Ptr")
●GetCommandLineW() = DLL("KERNEL32.dll", "char* GetCommandLineW()")
# 呼び出し: GetCommandLineW()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

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

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

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

let getcommandlinew =
  foreign "GetCommandLineW"
    (void @-> returning (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 ("GetCommandLineW" get-command-line-w :convention :stdcall) (:string :encoding :utf-16le))
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetCommandLineW = Win32::API::More->new('KERNEL32',
    'LPWSTR GetCommandLineW()');
# my $ret = $GetCommandLineW->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目