FParse

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/Parse.h

Include

#include "Misc/Parse.h"

Syntax

struct FParse

Functions

Name Description

Public function Static

bool

 

AlnumToken

(
    const TCHAR*& Str,
    FString& Arg
)

Grabs the next alpha-numeric space-delimited token from the input stream.

Public function Static

bool

 

Bool

(
    const TCHAR* Stream,
    const TCHAR* Match,
    bool& OnOff
)

Parses a boolean value.

Public function Static

bool

 

Command

(
    const TCHAR** Stream,
    const TCHAR* Match,
    bool bParseMightTriggerExecution
)

Sees if Stream starts with the named command.

Public function Static

int32

 

HexDigit

(
    TCHAR c
)

Parse a hex digit.

Public function Static

uint32

 

HexNumber

(
    const TCHAR* HexString
)

Parses a hexadecimal string value.

Public function Static

uint64

 

HexNumber64

(
    const TCHAR* HexString
)

Parses a hexadecimal string value.

Public function Static

bool

 

Line

(
    const TCHAR** Stream,
    FString& Resultd,
    bool Exact
)

Get a line of Stream (everything up to, but not including, CR/LF. Returns 0 if ok, nonzero if at end of stream and returned 0-length string.

Public function Static

bool

 

Line

(
    const TCHAR** Stream,
    TCHAR* Result,
    int32 MaxLen,
    bool Exact
)

Get a line of Stream (everything up to, but not including, CR/LF. Returns 0 if ok, nonzero if at end of stream and returned 0-length string.

Public function Static

bool

 

LineExtended

(
    const TCHAR** Stream,
    FString& Result,
    int32& LinesConsumed,
    bool Exact
)

Get a line of Stream, with support for extending beyond that line with certain characters, e.g. {} and \ the out character array will not include the ignored endlines

Public function Static

void

 

Next

(
    const TCHAR** Stream
)

Get next command. Skips past comments and cr's.

Public function Static

bool

 

Param

(
    const TCHAR* Stream,
    const TCHAR* Param
)

Checks if a command-line parameter exists in the stream.

Public function Static

bool

 

QuotedString

(
    const TCHAR* Stream,
    FStringBuilderBase& Value,
    int32* OutNumCharsRead
)

Parse a quoted string token.

Public function Static

bool

 

QuotedString

(
    const TCHAR* Stream,
    FString& Value,
    int32* OutNumCharsRead
)

Parse a quoted string token.

Public function Static

bool

 

Resolution

(
    const TCHAR* InResolution,
    uint32& OutX,
    uint32& OutY
)

Parses a resolution in the form 1920x1080.

Public function Static

bool

 

Resolution

(
    const TCHAR* InResolution,
    uint32& OutX,
    uint32& OutY,
    int32& OutWindowMode
)

Parses a resolution in the form 1920x1080.

Public function Static

bool

 

SchemeNameFromURI

(
    const TCHAR* InURI,
    FString& OutSchemeName
)

Parses the scheme name from a URI

Public function Static

bool

 

Text

(
    const TCHAR* Stream,
    FText& Value,
    const TCHAR* Namespace
)

Parse an Text token.

Public function Static

FString

 

Token

(
    const TCHAR*& Str,
    bool UseEscape
)

Grabs the next space-delimited string from the input stream. If quoted, gets entire quoted string.

Public function Static

bool

 

Token

(
    const TCHAR*& Str,
    FString& Arg,
    bool UseEscape
)

Grabs the next space-delimited string from the input stream. If quoted, gets entire quoted string.

Public function Static

bool

 

Token

(
    const TCHAR*& Str,
    TCHAR* Result,
    int32 MaxLen,
    bool UseEscape
)

Grabs the next space-delimited string from the input stream. If quoted, gets entire quoted string.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    FString& Value,
    bool bShouldStopOnSeparator
)

Parses a string.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    int64& Value
)

Parses a signed quadword.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    uint64& Value
)

Parses a quadword.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    int32& Value
)

Parses a signed double word.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    float& Value
)

Parses a floating-point value.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    int16& Value
)

Parses a signed word.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    int8& Value
)

Parses a signed byte.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    uint8& Value
)

Parses a byte.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    FGuid& Guid
)

Parses a globally unique identifier.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    uint32& Value
)

Parses a uint32.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    FName& Name
)

Parses a name.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    FText& Value,
    const TCHAR* Namespace
)

Parses an FText.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    uint16& Value
)

Parses a uint16.

Public function Static

bool

 

Value

(
    const TCHAR* Stream,
    const TCHAR* Match,
    TCHAR* Value,
    int32 MaxLen,
    bool bShouldStopOnSeparator
)

Parses a string from a text string.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss