Win32 API 日本語リファレンス
ホームUI.Shell › PathGetArgsW

PathGetArgsW

関数
コマンドライン文字列から引数部分の先頭ポインタを取得する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

LPWSTR PathGetArgsW(
    LPCWSTR pszPath
);

パラメーター

名前方向説明
pszPathLPCWSTRin検索対象のパスを格納する、最大長 MAX_PATH の null 終端文字列へのポインター。

戻り値の型: LPWSTR

公式ドキュメント

指定されたパス内のコマンドライン引数を検索します。(Unicode)

戻り値

型: PTSTR

成功した場合、パスの引数部分を格納した null 終端文字列へのポインターを返します。

パスに引数が含まれていない場合、この関数は入力文字列の末尾へのポインターを返します。

関数に NULL 引数が渡された場合は NULL を返します。

解説(Remarks)

この関数は、汎用的なコマンドパステンプレート(ユーザーやレジストリ由来のもの)に対して使用すべきではなく、アプリケーションが正しい形式であると把握しているテンプレートに対してのみ使用してください。

Examples


#include <windows.h>
#include <iostream.h>
#include "Shlwapi.h"

void main( void )
{
    // Path_1 to search for file arguments (2 arguments):
    char buffer_1[ ] = "test.exe temp.txt sample.doc"; 
    char *lpStr1;
    lpStr1 = buffer_1;
    
    // Path_2 to search for file arguments (3 arguments):
    char buffer_2[ ] = "test.exe 1 2 3"; 
    char *lpStr2;
    lpStr2 = buffer_2;
    
    // Path_3 to search for file arguments (3 arguments):
    char buffer_3[ ] = "test.exe sample All 15"; 
    char *lpStr3;
    lpStr3 = buffer_3;
    
    // Path_4 to search for file arguments (no arguments):
    char buffer_4[ ] = "test.exe"; 
    char *lpStr4;
    lpStr4 = buffer_4;
    
    cout << "The path passed to the function was : " << lpStr1 <<
            "\nThe arg(s)found in path 1 were      : " << PathGetArgs(lpStr1) << endl;
    
    cout << "\nThe path passed to the function was : " << lpStr2 <<
            "\nThe arg(s)found in path 2 were      : " << PathGetArgs(lpStr2) << endl;
    
    cout << "\nThe path passed to the function was : " << lpStr3 <<
            "\nThe arg(s)found in path 3 were      : " << PathGetArgs(lpStr3) << endl;
    
    cout << "\nThe path passed to the function was : " << lpStr4 <<
            "\nThe arg(s)found in path 4 were      : " << PathGetArgs(lpStr4) << endl;
}

OUTPUT:
===========
The path passed to the function was : test.exe temp.txt sample.doc
The arg(s)found in path 1 were      : temp.txt sample.doc

The path passed to the function was : test.exe 1 2 3
The arg(s)found in path 2 were      : 1 2 3

The path passed to the function was : test.exe sample All 15
The arg(s)found in path 3 were      : sample All 15

The path passed to the function was : test.exe
The arg(s)found in path 4 were      :
===========
メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PathGetArgs を定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

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

LPWSTR PathGetArgsW(
    LPCWSTR pszPath
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr PathGetArgsW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath   // LPCWSTR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathGetArgsW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String   ' LPCWSTR
) As IntPtr
End Function
' pszPath : LPCWSTR
Declare PtrSafe Function PathGetArgsW Lib "shlwapi" ( _
    ByVal pszPath As LongPtr) 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

PathGetArgsW = ctypes.windll.shlwapi.PathGetArgsW
PathGetArgsW.restype = wintypes.LPWSTR
PathGetArgsW.argtypes = [
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathGetArgsW = shlwapi.NewProc("PathGetArgsW")
)

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

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

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

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

let pathgetargsw =
  foreign "PathGetArgsW"
    ((ptr uint16_t) @-> returning (ptr uint16_t))
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("PathGetArgsW" path-get-args-w :convention :stdcall) (:string :encoding :utf-16le)
  (psz-path (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathGetArgsW = Win32::API::More->new('SHLWAPI',
    'LPWSTR PathGetArgsW(LPCWSTR pszPath)');
# my $ret = $PathGetArgsW->Call($pszPath);
# pszPath : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い