MiKTeX::Core::Session::InitInfo Class Reference

Extended initialization options. More...

#include <miktex/Core/Session.h>

Public Member Functions
	InitInfo (const InitInfo &other)=default
InitInfo &	operator= (const InitInfo &other)=default
	InitInfo (InitInfo &&other)=default
InitInfo &	operator= (InitInfo &&other)=default
	InitInfo (const std::string &programInvocationName)
	InitInfo (const std::string &programInvocationName, InitOptionSet options)
void	SetOptions (InitOptionSet options)
InitOptionSet	GetOptions () const
void	AddOption (InitOption option)
void	SetProgramInvocationName (const std::string &programInvocationName)
std::string	GetProgramInvocationName () const
void	SetTheNameOfTheGame (const std::string &theNameOfTheGame)
std::string	GetTheNameOfTheGame () const
void	SetStartupConfig (const StartupConfig &startupConfig)
StartupConfig	GetStartupConfig () const
void	SetTraceFlags (const std::string &traceFlags)
std::string	GetTraceFlags () const
void	SetTraceCallback (MiKTeX::Trace::TraceCallback *callback)
MiKTeX::Trace::TraceCallback *	GetTraceCallback ()

Detailed Description

Extended initialization options.

Constructor & Destructor Documentation

InitInfo() [1/2]

MiKTeX::Core::Session::InitInfo::InitInfo ( const std::string &  programInvocationName )

inline

Constructor.

Parameters

programInvocationName

Name of the program.

InitInfo() [2/2]

MiKTeX::Core::Session::InitInfo::InitInfo ( const std::string &  programInvocationName, InitOptionSet  options  )

inline

Constructor.

Parameters

programInvocationName	Name of the program.
flags	Initialization options.

Member Function Documentation

AddOption()

void MiKTeX::Core::Session::InitInfo::AddOption ( InitOption  option )

inline

Add an initializtion option.

Parameters

option

The option to add.

GetOptions()

InitOptionSet MiKTeX::Core::Session::InitInfo::GetOptions ( ) const

inline

Gets initialization options.

Returns

Returns initialization options.

GetProgramInvocationName()

std::string MiKTeX::Core::Session::InitInfo::GetProgramInvocationName ( ) const

inline

Gets the name of the program.

Returns

Returns the program name.

GetStartupConfig()

StartupConfig MiKTeX::Core::Session::InitInfo::GetStartupConfig ( ) const

inline

Gets the startup options.

Returns

Return s the startup options.

GetTheNameOfTheGame()

std::string MiKTeX::Core::Session::InitInfo::GetTheNameOfTheGame ( ) const

inline

Gets the descriptive program name.

Returns

Returns the descriptive program name.

GetTraceCallback()

MiKTeX::Trace::TraceCallback * MiKTeX::Core::Session::InitInfo::GetTraceCallback ( )

inline

Gets the trace callback interface.

Returns

Returns the pointer to an object implementing the trace callback interface.

GetTraceFlags()

std::string MiKTeX::Core::Session::InitInfo::GetTraceFlags ( ) const

inline

Gets enabled trace streams.

Returns

Returns enabled trace stream names.

SetOptions()

void MiKTeX::Core::Session::InitInfo::SetOptions ( InitOptionSet  options )

inline

Sets initialization options.

Parameters

options

the options to set.

SetProgramInvocationName()

void MiKTeX::Core::Session::InitInfo::SetProgramInvocationName ( const std::string &  programInvocationName )

inline

Sets the name of the program.

Parameters

programInvocationName

The name of the program.

SetStartupConfig()

void MiKTeX::Core::Session::InitInfo::SetStartupConfig ( const StartupConfig &  startupConfig )

inline

Sets the startup options.

Parameters

startupConfig

The startup options to set.

SetTheNameOfTheGame()

void MiKTeX::Core::Session::InitInfo::SetTheNameOfTheGame ( const std::string &  theNameOfTheGame )

inline

Sets the descriptive program name.

Parameters

theNameOfTheGame

The descriptive program name.

SetTraceCallback()

void MiKTeX::Core::Session::InitInfo::SetTraceCallback ( MiKTeX::Trace::TraceCallback *  callback )

inline

Sets the trace callback interface.

Parameters

callback

Pointer to an object implementing the trace callback interface.

SetTraceFlags()

void MiKTeX::Core::Session::InitInfo::SetTraceFlags ( const std::string &  traceFlags )

inline

Enables trace streams.

Parameters

The	trace streams (by name) to enable.

---

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

• Libraries/MiKTeX/Core/include/miktex/Core/Session.h