1. Epic GamesDeveloper
  3. FCommandLine

FCommandLine

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/CommandLine.h
Include #include "Misc/CommandLine.h"

Syntax

struct FCommandLine

Functions

  Type Name Description
Public function Static void

AddToSubprocessCommandline ( const TCHAR* Param
)

 Adds a new parameter to subprocess command line.
Public function Static void

Append ( const TCHAR* AppendString
)

 Appends the passed string to the command line as it is (no space is added).
Public function Static FString

BuildFromArgV ( const WIDECHAR* Prefix,
int32 ArgC,
WIDECHAR* ArgV,
const WIDECHAR* Suffix
)

 Builds a command line string from the ArgC/ArgV main() arguments, together with an optional prefix or suffix, for adding additional command list arguments programmatically.
Public function Static FString

BuildFromArgV ( const ANSICHAR* Prefix,
int32 ArgC,
ANSICHAR* ArgV,
const ANSICHAR* Suffix
)

 Builds a command line string from the ArgC/ArgV main() arguments, together with an optional prefix or suffix, for adding additional command list arguments programmatically.
Public function Static bool

FilterCLIUsingGrammarBasedParser ( TCHAR* OutLine,
int32 MaxLen,
const TCHAR* InLine,
const TArrayView< FString >& AllowedList
)

 FilterCLIUsingGrammarBasedParser parses CLI style arguments.
Public function Static const TCHAR *

Get ()

 Returns an edited version of the executable's command line with the game name and certain other parameters removed.
Public function Static const TCHAR * Returns an edited version of the executable's command line.
Public function Static const TCHAR * Returns the command line originally passed to the executable.
Public function Static const TCHAR * Returns an edited version of the command line originally passed to the executable.
Public function Static const FString & Returns the subprocess command line string
Public function Static bool Checks if command line logging filtering is enabledReturns true if logging filter is enabled
Public function Static bool Checks if the command line has been initialized.
Public function Static void

Parse ( const TCHAR* CmdLine,
TArray< FString >& Tokens,
TArray< FString >& Switches
)

 Parses a string into tokens, separating switches (beginning with -) from other parameters
Public function Static const TCHAR *

RemoveExeName ( const TCHAR* CmdLine
)

 Removes the executable name from the passed CmdLine, denoted by parentheses.
Public function Static void

Reset ()

 Resets FCommandLine to an uninitialised state as if Set() has never been called
Public function Static bool

Set ( const TCHAR* NewCommandLine
)

 Sets CmdLine to the string given

Constants

Name Description
bIsInitialized Flag to check if the commandline has been initialized or not.
CmdLine Character buffer containing the command line
LoggingCmdLine Character buffer containing the command line filtered for logging purposes
LoggingOriginalCmdLine Character buffer containing the original command line filtered for logging purposes
MaxCommandLineSize Maximum size of the command line
OriginalCmdLine Character buffer containing the original command line

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page