PathRemoveArgsA

関数

コマンドライン文字列から引数部分を取り除く。

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

void PathRemoveArgsA(
    LPSTR pszPath
);

パラメーター

名前	型	方向	説明
pszPath	LPSTR	inout	引数を削除する対象のパスを格納した、長さ MAX_PATH の null 終端文字列へのポインター。

戻り値の型: void

公式ドキュメント

指定されたパスから引数をすべて削除します。(ANSI)

解説(Remarks)

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

使用例

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

void main( void )
{
    // Path with arguments.
    char buffer_1[ ] = "c:\\a\\b\\FileA Arg1 Arg2"; 
    char *lpStr1;
    lpStr1 = buffer_1;
    
    // Path before "PathRemoveArgs".
    cout << "Path before calling \"PathRemoveArgs\": " << lpStr1 << endl;
    
    // Call function "PathRemoveArgs".
    PathRemoveArgs(lpStr1);
    
    // Path after "PathRemoveArgs".
    cout << "Path after calling \"PathRemoveArgs\": " << lpStr1 << endl;
}

OUTPUT:
==================
Path before calling "PathRemoveArgs": c:\a\b\FileA Arg1 Arg2
Path after calling "PathRemoveArgs": c:\a\b\FileA

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PathRemoveArgs を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在させて使用すると、不整合が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、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>

void PathRemoveArgsA(
    LPSTR pszPath
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern void PathRemoveArgsA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath   // LPSTR in/out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Sub PathRemoveArgsA(
    <MarshalAs(UnmanagedType.LPStr)> pszPath As System.Text.StringBuilder   ' LPSTR in/out
)
End Sub

' pszPath : LPSTR in/out
Declare PtrSafe Sub PathRemoveArgsA Lib "shlwapi" ( _
    ByVal pszPath As String)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PathRemoveArgsA = ctypes.windll.shlwapi.PathRemoveArgsA
PathRemoveArgsA.restype = None
PathRemoveArgsA.argtypes = [
    wintypes.LPSTR,  # pszPath : LPSTR in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathRemoveArgsA = Fiddle::Function.new(
  lib['PathRemoveArgsA'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPSTR in/out
  ],
  Fiddle::TYPE_VOID)

#[link(name = "shlwapi")]
extern "system" {
    fn PathRemoveArgsA(
        pszPath: *mut u8  // LPSTR in/out
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern void PathRemoveArgsA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathRemoveArgsA' -Namespace Win32 -PassThru
# $api::PathRemoveArgsA(pszPath)

#uselib "SHLWAPI.dll"
#func global PathRemoveArgsA "PathRemoveArgsA" sptr
; PathRemoveArgsA varptr(pszPath)
; pszPath : LPSTR in/out -> "sptr"

出力引数:

#uselib "SHLWAPI.dll"
#func global PathRemoveArgsA "PathRemoveArgsA" var
; PathRemoveArgsA pszPath
; pszPath : LPSTR in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#func global PathRemoveArgsA "PathRemoveArgsA" sptr
; PathRemoveArgsA varptr(pszPath)
; pszPath : LPSTR in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。