Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Support Forum
Download Visual Studio Add-In

Terms of Use
Privacy Policy
pathgetargs (shlwapi)
 
.
Summary
PathGetArgs - Finds the command line arguments within a given path.

C# Signature:

/// <summary>
/// Finds the command line arguments within a given path.
/// </summary>
/// <param name="pszPath">Pointer to a null-terminated string of maximum length MAX_PATH that contains the path to be searched.</param>
/// <returns>
/// Returns a pointer to a null-terminated string that contains the arguments portion of the path if successful.
/// If there are no arguments in the path, the function returns a pointer to the end of the input string.
/// </returns>
[DllImport("shlwapi.dll", EntryPoint = "PathGetArgsW",  SetLastError = True, CharSet= CharSet.Unicode)]
[return MarshalAs(UnmanagedType.LPTStr)]
static extern System.Text.StringBuilder PathGetArgs([MarshalAs(UnmanagedType.LPTStr)]string pszPath);

VB.NET Signature

''' <summary>
''' Finds the command line arguments within a given path.
''' </summary>
''' <param name="pszPath">Pointer to a null-terminated string of maximum length MAX_PATH that contains the path to be searched.</param>
''' <returns>
''' Returns a pointer to a null-terminated string that contains the arguments portion of the path if successful.
''' If there are no arguments in the path, the function returns a pointer to the end of the input string.
''' </returns>
<DllImport("shlwapi.dll", EntryPoint:="PathGetArgsW",  SetLastError:=True, CharSet:=CharSet.Unicode)> _
Public Function PathGetArgs(<MarshalAs(UnmanagedType.LPTStr)>pszPath As String) As <MarshalAs(UnmanagedType.LPTStr)> System.Text.StringBuilder
End Function

VB Signature:

Public Declare Function PathGetArgs Lib "shlwapi" Alias "PathGetArgsA" _
        (ByVal pszPath As String) As Long

User-Defined Types:

None.

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

None.

Tips & Tricks:

Please add some.

Sample Code:

VB.NET Example

Dim args As New System.Text.StringBuilder(255)

args = Win32.API.Shlwapi.PathGetArgs("c:\abc.exe 1 2 3 4")
System.Diagnostics.Debug.WriteLine(args.ToString())

Documentation
PathGetArgs on MSDN

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions