plArgSensitive Struct Reference

Wraps a string that may contain sensitive information, such as user file paths. More...

#include <FormatStringArgs.h>

Public Types
using	BuildStringCallback = plStringView (*)(char*, plUInt32, const plArgSensitive&)

Public Member Functions
	plArgSensitive (const plStringView &sSensitiveInfo, const char *szContext=nullptr)

Static Public Member Functions
static PL_FOUNDATION_DLL plStringView	BuildString_SensitiveUserData_Hash (char *szTmp, plUInt32 uiLength, const plArgSensitive &arg)
	Set s_BuildStringCB to this function to enable scrambling of sensitive data.

Public Attributes
const plStringView	m_sSensitiveInfo
const char *	m_szContext

Static Public Attributes
static PL_FOUNDATION_DLL BuildStringCallback	s_BuildStringCB = nullptr

Detailed Description

Wraps a string that may contain sensitive information, such as user file paths.

The application can specify a function to scramble this type of information. By default no such function is set. A general purpose function is provided with 'BuildString_SensitiveUserData_Hash()'

Parameters

sSensitiveInfo	The information that may need to be scrambled.
szContext	A custom string to identify the 'context', ie. what type of sensitive data is being scrambled. This may be passed through unmodified, or can guide the scrambling function to choose how to output the sensitive data.

---

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

• Code/Engine/Foundation/Strings/Implementation/FormatStringArgs.h
• Code/Engine/Foundation/Strings/Implementation/FormatString.cpp