MiKTeX::Core::VersionNumber Struct Reference

An instance of this struct represents a version number. More...

#include <miktex/Core/VersionNumber.h>

Public Member Functions
	VersionNumber (const VersionNumber &other)=default
VersionNumber &	operator= (const VersionNumber &other)=default
	VersionNumber (VersionNumber &&other)=default
VersionNumber &	operator= (VersionNumber &&other)=default
	VersionNumber (unsigned n1, unsigned n2, unsigned n3, unsigned n4)
	VersionNumber (long highWord, long lowWord)
	VersionNumber (const std::string &versionString)
	VersionNumber (const char *versionString)
long	GetHighWord () const
long	GetLowWord () const
int	CompareTo (const VersionNumber &other) const
std::string	ToString () const

Static Public Member Functions
static bool	TryParse (const std::string &versionString, VersionNumber &versionNumber)
static VersionNumber	Parse (const std::string &versionString)

Public Attributes
unsigned	n1 = 0
	The first part of the version number. Usually the major version. More...
unsigned	n2 = 0
	The second part of the version number. Usually the minor version. More...
unsigned	n3 = 0
	The third part of the version number. Usually the j2000 number. More...
unsigned	n4 = 0
	The fourth part of the version nimber. Usually 0. More...

Detailed Description

An instance of this struct represents a version number.

Constructor & Destructor Documentation

VersionNumber() [1/3]

MiKTeX::Core::VersionNumber::VersionNumber ( unsigned  n1, unsigned  n2, unsigned  n3, unsigned  n4  )

inline

Initializes an instance of the struct.

Parameters

n1	The first part of the version number.
n2	The second part of the version number.
n3	The third part of the version number.
n4	The fourth part of the version number.

VersionNumber() [2/3]

MiKTeX::Core::VersionNumber::VersionNumber ( const std::string &  versionString )

inlineexplicit

Initializes an instance of the struct.

Parameters

versionString

The version number as a string.

VersionNumber() [3/3]

MiKTeX::Core::VersionNumber::VersionNumber ( const char *  versionString )

inlineexplicit

Initializes an instance of the struct.

Parameters

versionString

The version number as a string.

Member Function Documentation

CompareTo()

int MiKTeX::Core::VersionNumber::CompareTo ( const VersionNumber &  other ) const

inline

Compares this version number to another.

Parameters

other

The other version number.

Returns

Returns -1, if this version number is less than the other. Returns 0, if both version numbers compare equal. Otherwise returns 1.

GetHighWord()

long MiKTeX::Core::VersionNumber::GetHighWord ( ) const

inline

Combines the first two parts of the version number.

Returns

Returns a 32-bit integer.

GetLowWord()

long MiKTeX::Core::VersionNumber::GetLowWord ( ) const

inline

Combines the last two parts of the version number.

Returns

Returns a 32-bit integer.

Parse()

static VersionNumber MiKTeX::Core::VersionNumber::Parse ( const std::string &  versionString )

static

Parses the string representation of a version number.

Parameters

versionString

The string to parse.

Returns

Returns the parsed version number.

ToString()

std::string MiKTeX::Core::VersionNumber::ToString

(

)

const

Converts this version number into a string object.

Returns

Returns the string object.

TryParse()

static bool MiKTeX::Core::VersionNumber::TryParse ( const std::string &  versionString, VersionNumber &  versionNumber  )

static

Parses the string representation of a version number.

Parameters

	versionString	The string to parse.
[out]	The	version number object to fill.

Returns

Returns true if the string could be parsed.

Member Data Documentation

n1

unsigned MiKTeX::Core::VersionNumber::n1 = 0

The first part of the version number. Usually the major version.

n2

unsigned MiKTeX::Core::VersionNumber::n2 = 0

The second part of the version number. Usually the minor version.

n3

unsigned MiKTeX::Core::VersionNumber::n3 = 0

The third part of the version number. Usually the j2000 number.

n4

unsigned MiKTeX::Core::VersionNumber::n4 = 0

The fourth part of the version nimber. Usually 0.

---

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

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