FOperatingSystemUniqueId
#include <OperatingSystemSimulator/Public/OperatingSystemUniqueId.h>Class detail
Section titled “Class detail”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class FOperatingSystemUniqueId {
+FOperatingSystemUniqueId()
+FOperatingSystemUniqueId(const FString &UniqueId)
+IsValid() const bool
+GetID(FString &OutID) const bool
+ToString() const FString
+operator==(const FOperatingSystemUniqueId &Other) cons bool
+GenerateNewId() FOperatingSystemUniqueId()
+UniqueId : TOptional< FString >
}
Caller impact — ToString
Section titled “Caller impact — ToString”Documented call sites inside the plugin (4):
flowchart LR FOperatingSystemUniqueId__ToString["FOperatingSystemUniqueId::ToString"] FOperatingSystemUser__GetUserUniqueId["FOperatingSystemUser::GetUserUniqueId"] FOperatingSystemUser__GetUserUniqueId --> FOperatingSystemUniqueId__ToString UOperatingSystem__Internal_LoadSettings["UOperatingSystem::Internal_LoadSettings"] UOperatingSystem__Internal_LoadSettings --> FOperatingSystemUniqueId__ToString UOperatingSystemGameSubsystem__RequestFundsFromBank["UOperatingSystemGameSubsystem::RequestFundsFromBank"] UOperatingSystemGameSubsystem__RequestFundsFromBank --> FOperatingSystemUniqueId__ToString UOperatingSystemStatics__UniqueIdToString["UOperatingSystemStatics::UniqueIdToString"] UOperatingSystemStatics__UniqueIdToString --> FOperatingSystemUniqueId__ToString
class FOperatingSystemUniqueIdDefined in OperatingSystemUniqueId.h:17 This class represents a unique identifier for an operating system.
The FOperatingSystemUniqueId class provides functionality to generate a new unique identifier, as well as check whether the identifier is valid and retrieve its string representation. It also provides comparison operators to compare two identifiers for equality.
Public Methods
Section titled “Public Methods”| Return | Name | Description |
|---|---|---|
FOperatingSystemUniqueId inline | ||
FOperatingSystemUniqueId inline | ||
bool | IsValid const inline | Check whether the unique identifier is valid. |
bool | GetID const inline | Retrieves the unique identifier. |
FString | ToString const inline | Converts the unique identifier to a string representation. |
bool | operator== const inline |
FOperatingSystemUniqueId
Section titled “FOperatingSystemUniqueId”inline
inline FOperatingSystemUniqueId()Defined in OperatingSystemUniqueId.h:27
Section titled “Defined in OperatingSystemUniqueId.h:27”FOperatingSystemUniqueId
Section titled “FOperatingSystemUniqueId”inline
inline FOperatingSystemUniqueId(const FString & UniqueId)Defined in OperatingSystemUniqueId.h:32
Section titled “Defined in OperatingSystemUniqueId.h:32”IsValid
Section titled “IsValid”const inline
inline bool IsValid() constDefined in OperatingSystemUniqueId.h:65 Check whether the unique identifier is valid.
This method checks whether the unique identifier is valid. The identifier is considered valid if it is set.
Returns
Section titled “Returns”True if the unique identifier is valid, false otherwise.
Referenced by
Section titled “Referenced by”const inline
inline bool GetID(FString & OutID) constDefined in OperatingSystemUniqueId.h:78 Retrieves the unique identifier.
This method retrieves the unique identifier for the operating system. If the unique identifier is set, it is assigned to the parameter OutID, and the method returns true. Otherwise, OutID is assigned an empty string, and the method returns false.
Parameters
Section titled “Parameters”OutIDThe output parameter to store the unique identifier.
Returns
Section titled “Returns”True if the unique identifier is set and retrieved successfully, false otherwise.
ToString
Section titled “ToString”const inline
inline FString ToString() constDefined in OperatingSystemUniqueId.h:99 Converts the unique identifier to a string representation.
This method converts the unique identifier to a string representation. If the unique identifier is set, it assigns it to the variable OutID and returns it. If the unique identifier is not set, it assigns an empty string to the variable OutID and returns it.
Returns
Section titled “Returns”The string representation of the unique identifier.
Referenced by
Section titled “Referenced by”operator==
Section titled “operator==”const inline
inline bool operator==(const FOperatingSystemUniqueId & Other) constDefined in OperatingSystemUniqueId.h:110
References
Section titled “References”Public Static Methods
Section titled “Public Static Methods”| Return | Name | Description |
|---|---|---|
FOperatingSystemUniqueId | GenerateNewId static inline | Generates a new unique identifier for the operating system. This method generates a new unique identifier for the operating system by combining the current date and time with milliseconds. |
GenerateNewId
Section titled “GenerateNewId”static inline
static inline FOperatingSystemUniqueId GenerateNewId()Defined in OperatingSystemUniqueId.h:43 Generates a new unique identifier for the operating system. This method generates a new unique identifier for the operating system by combining the current date and time with milliseconds.
Returns
Section titled “Returns”A new unique identifier generated for the operating system.
Referenced by
Section titled “Referenced by”References
Section titled “References”INT_TO_STRING
Private Attributes
Section titled “Private Attributes”| Return | Name | Description |
|---|---|---|
TOptional< FString > | UniqueId |
UniqueId
Section titled “UniqueId”TOptional< FString > UniqueIdDefined in OperatingSystemUniqueId.h:23