ConfigFromIni

Configuration helper classes and methods.

Windows
MacOS
Linux

References

Module

Analytics

Header

/Engine/Source/Runtime/Analytics/Analytics/Public/Analytics.h

Include

#include "Analytics.h"

Syntax

struct ConfigFromIni

Remarks

A common way of configuring is from Inis, so this class supports that notion directly by providing a configuration class with a method suitable to be used as an FAnalyticsProviderConfigurationDelegate that reads values from the specified ini and section (based on the BuildType). Also provides a default location to store a provider name, accessed via GetDefaultProviderModuleName().

Variables

Name Description

Public variable

FString

 

IniName

Ini file name to find the config values.

Public variable

FString

 

SectionName

Section name in the Ini file in which to find the keys.

Constructors

Name Description

Public function

ConfigFromIni()

Create a config using the default values: IniName - GEngineIni SectionName (Development) = AnalyticsDevelopment SectionName (Debug) = AnalyticsDebug SectionName (Test) = AnalyticsTest SectionName (Release) = Analytics

Public function

ConfigFromIni

(
    EAnalyticsBuildType InBuildType
)

Create a config AS IF the BuildType matches the one passed in.

Public function

ConfigFromIni

(
    const FString& InIniName,
    const FString& InSectionName
)

Create a config, specifying the Ini name and a single section name for all build types.

Public function

ConfigFromIni

(
    const FString& InIniName,
    const FString& SectionNameDevelopm...,
    const FString& SectionNameDebug,
    const FString& SectionNameTest,
    const FString& SectionNameRelease
)

Create a config, specifying the Ini name and the section name for each build type.

Functions

Name Description

Public function Static

FName

 

GetDefaultProviderModuleName()

Reads the ProviderModuleName key from the Analytics section of GEngineIni, which is the default, preferred location to look for the analytics provider name.

Public function Const

FString

 

GetValue

(
    const FString& KeyName,
    bool bIsRequired
)

Method that can be bound to an FAnalyticsProviderConfigurationDelegate.

Public function

void

 

SetSectionNameByBuildType

(
    EAnalyticsBuildType InBuildType
)

Allows setting the INI section name based on the build type passed in.

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