FCommandLine Struct Reference

#include <CommandLine.h>

Collaboration diagram for FCommandLine:

Static Public Member Functions
static void	Reset ()
static const TCHAR *	Get ()
static const TCHAR *	GetForLogging ()
static const TCHAR *	GetOriginal ()
static const TCHAR *	GetOriginalForLogging ()
static bool	IsInitialized ()
static bool	Set (const TCHAR *NewCommandLine)
static void	Append (const TCHAR *AppendString)
static void	AddToSubprocessCommandline (const TCHAR *Param)
static const FString &	GetSubprocessCommandline ()
static const TCHAR *	RemoveExeName (const TCHAR *CmdLine)
static void	Parse (const TCHAR *CmdLine, TArray< FString > &Tokens, TArray< FString > &Switches)
static bool	IsCommandLineLoggingFiltered ()
static FString	BuildFromArgV (const TCHAR *Prefix, int32 ArgC, TCHAR *ArgV[], const TCHAR *Suffix)

Static Public Attributes
static constexpr uint32	MaxCommandLineSize = 16384

Static Private Member Functions
static FString &	GetSubprocessCommandLine_Internal ()

Static Private Attributes
static bool	bIsInitialized
static TCHAR	CmdLine [MaxCommandLineSize]
static TCHAR	OriginalCmdLine [MaxCommandLineSize]
static TCHAR	LoggingCmdLine [MaxCommandLineSize]
static TCHAR	LoggingOriginalCmdLine [MaxCommandLineSize]

Detailed Description

Definition at line 23 of file CommandLine.h.

Member Function Documentation

AddToSubprocessCommandline()

static void FCommandLine::AddToSubprocessCommandline ( const TCHAR * Param )

static

Adds a new parameter to subprocess command line. If Param does not start with a space, one is added.

Parameters

Param

Command line param string.

Append()

static void FCommandLine::Append ( const TCHAR * AppendString )

static

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

Parameters

AppendString

String that should be appended to the commandline.

BuildFromArgV()

static FString FCommandLine::BuildFromArgV ( const TCHAR * Prefix, int32 ArgC, TCHAR * ArgV[], const TCHAR * Suffix )

static

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.

Get()

static const TCHAR * FCommandLine::Get ( )

static

Returns an edited version of the executable's command line with the game name and certain other parameters removed.

Here is the caller graph for this function:

GetForLogging()

static const TCHAR * FCommandLine::GetForLogging ( )

static

Returns an edited version of the executable's command line.

GetOriginal()

static const TCHAR * FCommandLine::GetOriginal ( )

static

Returns the command line originally passed to the executable.

GetOriginalForLogging()

static const TCHAR * FCommandLine::GetOriginalForLogging ( )

static

Returns an edited version of the command line originally passed to the executable.

GetSubprocessCommandline()

static const FString & FCommandLine::GetSubprocessCommandline ( )

static

Returns the subprocess command line string

GetSubprocessCommandLine_Internal()

static FString & FCommandLine::GetSubprocessCommandLine_Internal ( )

staticprivate

subprocess command line

IsCommandLineLoggingFiltered()

static bool FCommandLine::IsCommandLineLoggingFiltered ( )

static

Checks if command line logging filtering is enabled

Returns true if logging filter is enabled

IsInitialized()

static bool FCommandLine::IsInitialized ( )

static

Checks if the command line has been initialized.

Here is the caller graph for this function:

Parse()

static void FCommandLine::Parse ( const TCHAR * CmdLine, TArray< FString > & Tokens, TArray< FString > & Switches )

static

Parses a string into tokens, separating switches (beginning with -) from other parameters

Parameters

CmdLine	the string to parse
Tokens	[out] filled with all parameters found in the string
Switches	[out] filled with all switches found in the string

RemoveExeName()

static const TCHAR * FCommandLine::RemoveExeName ( const TCHAR * CmdLine )

static

Removes the executable name from the passed CmdLine, denoted by parentheses. Returns the CmdLine string without the executable name.

Reset()

static void FCommandLine::Reset ( )

static

Resets FCommandLine to an uninitialised state as if Set() has never been called

Set()

static bool FCommandLine::Set ( const TCHAR * NewCommandLine )

static

Sets CmdLine to the string given

Member Data Documentation

bIsInitialized

bool FCommandLine::bIsInitialized

staticprivate

Flag to check if the commandline has been initialized or not.

Definition at line 128 of file CommandLine.h.

CmdLine

TCHAR FCommandLine::CmdLine[MaxCommandLineSize]

staticprivate

character buffer containing the command line

Definition at line 130 of file CommandLine.h.

LoggingCmdLine

TCHAR FCommandLine::LoggingCmdLine[MaxCommandLineSize]

staticprivate

character buffer containing the command line filtered for logging purposes

Definition at line 134 of file CommandLine.h.

LoggingOriginalCmdLine

TCHAR FCommandLine::LoggingOriginalCmdLine[MaxCommandLineSize]

staticprivate

character buffer containing the original command line filtered for logging purposes

Definition at line 136 of file CommandLine.h.

MaxCommandLineSize

constexpr uint32 FCommandLine::MaxCommandLineSize = 16384

staticconstexpr

maximum size of the command line

Definition at line 26 of file CommandLine.h.

OriginalCmdLine

TCHAR FCommandLine::OriginalCmdLine[MaxCommandLineSize]

staticprivate

character buffer containing the original command line

Definition at line 132 of file CommandLine.h.

---

The documentation for this struct was generated from the following file:

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Misc/CommandLine.h