Navigation
API > API/Runtime > API/Runtime/Core
| Name | FCommandLine |
| Type | struct |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/CommandLine.h |
| Include Path | #include "Misc/CommandLine.h" |
Syntax
struct FCommandLine
Structs
| Name | Remarks |
|---|---|
| FRegisteredArgData |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| bIsInitialized | bool | Flag to check if the commandline has been initialized or not. | Misc/CommandLine.h |
| CmdLine | TCHAR | Character buffer containing the command line | Misc/CommandLine.h |
| CmdLineVersion | uint32 | What version of the command line this is, incremented on any modification to the command line | Misc/CommandLine.h |
| LoggingCmdLine | TCHAR | Character buffer containing the command line filtered for logging purposes | Misc/CommandLine.h |
| LoggingOriginalCmdLine | TCHAR | Character buffer containing the original command line filtered for logging purposes | Misc/CommandLine.h |
| MaxCommandLineSize | uint32 | Maximum size of the command line | Misc/CommandLine.h |
| OriginalCmdLine | TCHAR | Character buffer containing the original command line | Misc/CommandLine.h |
| RegisteredArgs | TMap< FString, FRegisteredArgData > | Misc/CommandLine.h |
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddToSubprocessCommandline
(
const TCHAR* Param |
Adds a new parameter to subprocess command line. | Misc/CommandLine.h | |
static void AddToSubprocessCommandLine
(
const TCHAR* Param, |
Adds a new parameter to subprocess command line. | Misc/CommandLine.h | |
static void AddToSubprocessCommandLine_Internal
(
const TCHAR* Param, |
Add subprocess command lines | Misc/CommandLine.h | |
static void Append
(
const TCHAR* AppendString |
Appends the passed string to the command line as it is (no space is added). | Misc/CommandLine.h | |
static FString BuildFromArgV
(
const WIDECHAR* Prefix, |
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. | Misc/CommandLine.h | |
static FString BuildFromArgV
(
const ANSICHAR* Prefix, |
Misc/CommandLine.h | ||
static void BuildSubprocessCommandLine
(
ECommandLineArgumentFlags ApplicationContextFlags, |
Builds a commandline of inheritable and subprocess arguments for a specified application context. | Misc/CommandLine.h | |
static bool FilterCLIUsingGrammarBasedParser
(
TCHAR* OutLine, |
FilterCLIUsingGrammarBasedParser parses CLI style arguments. | Misc/CommandLine.h | |
static const TCHAR * Get() |
Returns an edited version of the executable's command line with the game name and certain other parameters removed. | Misc/CommandLine.h | |
static uint32 GetCommandLineVersion() |
Gets a number representing this version of the command line, incremented each command line change | Misc/CommandLine.h | |
static const TCHAR * GetForLogging() |
Returns an edited version of the executable's command line. | Misc/CommandLine.h | |
static const TCHAR * GetOriginal() |
Returns the command line originally passed to the executable. | Misc/CommandLine.h | |
static const TCHAR * GetOriginalForLogging() |
Returns an edited version of the command line originally passed to the executable. | Misc/CommandLine.h | |
static const FString & GetSubprocessCommandline() |
Returns the subprocess command line string (without inherited or context specific arguments) | Misc/CommandLine.h | |
static FString & GetSubprocessCommandLine_Internal
(
ECommandLineArgumentFlags ContextFlags |
Subprocess command lines | Misc/CommandLine.h | |
static bool IsCommandLineLoggingFiltered() |
Checks if command line logging filtering is enabledReturns true if logging filter is enabled | Misc/CommandLine.h | |
static bool IsInitialized() |
Checks if the command line has been initialized. | Misc/CommandLine.h | |
| Parses a string into tokens, separating switches (beginning with -) from other parameters | Misc/CommandLine.h | ||
static void RegisterArgument
(
FStringView Name, |
Registers a command line argument and associates it with a set of flags and optionally a description. | Misc/CommandLine.h | |
static const TCHAR * RemoveExeName
(
const TCHAR* CmdLine |
Removes the executable name from the passed CmdLine, denoted by parentheses. | Misc/CommandLine.h | |
static void Reset() |
Resets FCommandLine to an uninitialised state as if Set() has never been called | Misc/CommandLine.h | |
static bool Set
(
const TCHAR* NewCommandLine |
Sets CmdLine to the string given | Misc/CommandLine.h |