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

PathGetArgsA

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

シグネチャ

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

LPSTR PathGetArgsA(
    LPCSTR pszPath
);

パラメーター

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

戻り値の型: LPSTR

公式ドキュメント

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

戻り値

型: PTSTR

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

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

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

解説(Remarks)

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


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

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

各言語での呼び出し定義

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

LPSTR PathGetArgsA(
    LPCSTR pszPath
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr PathGetArgsA(
    [MarshalAs(UnmanagedType.LPStr)] string pszPath   // LPCSTR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathGetArgsA(
    <MarshalAs(UnmanagedType.LPStr)> pszPath As String   ' LPCSTR
) As IntPtr
End Function
' pszPath : LPCSTR
Declare PtrSafe Function PathGetArgsA Lib "shlwapi" ( _
    ByVal pszPath As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PathGetArgsA = ctypes.windll.shlwapi.PathGetArgsA
PathGetArgsA.restype = wintypes.LPSTR
PathGetArgsA.argtypes = [
    wintypes.LPCSTR,  # pszPath : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathGetArgsA = shlwapi.NewProc("PathGetArgsA")
)

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

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

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

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

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

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

関連項目

文字セット違い