MES Stateful API

ParseNameAndArgs Method

Save PDF

ParseNameAndArgs Method

Save PDF

Last UpdatedNov 06, 2025
2 minute read

The ParseNameAndArgs() method takes a string that contains a name (that is, an external program or form name) and any arguments to be passed and parses out and returns the name and arguments. If a parameter is preceded by an @ symbol, it assumed to be global; otherwise, the parameter is assumed to be part of the current grid row. If a parameter is not found, it is added to the command line as a literal string.

If parameters are included, they must be separated by commas and cannot have a space either before or after them. Literals must also be separated from parameters by commas.

Syntax

'Declaration
 
Public Shared Sub ParseNameAndArgs( _
   ByVal stringToParse As String, _
   ByVal gridRow As Xceed.Grid.DataRow, _
   ByVal browser As Boolean, _
   ByVal formBeingProcessed As Boolean, _
   ByRef commandName As String, _
   ByRef args As String _
)

public static void ParseNameAndArgs( 
   string stringToParse,
   Xceed.Grid.DataRow gridRow,
   bool browser,
   bool formBeingProcessed,
   out string commandName,
   out string args
)

Parameters

stringToParse: Required. Holds the name (program to execute or form), parameters, and literals that make up the arguments for the program.
gridRow: Optional. Holds the currently selected row in the control's grid. Set to null if no row is selected.
browser: Required. Holds a flag that, if set to true, indicates that a browser is being called.
formBeingProcessed: Required. Holds a flag that, if set to true, specifies that the entire input string be processed as arguments, rather than as a command name and arguments.
commandName: Outputs. Holds the returned program or form name.
args: Outputs. Holds the returned arguments.

MES Stateful API