Class GdkVersion

Utility class for the GDK Discovery package.

Inheritance
object
GdkVersion
Inherited Members
Namespace: Unity.Microsoft.GDK.Discovery
Assembly: Unity.Microsoft.GDK.Discovery.dll
Syntax
public static class GdkVersion

Methods

Format(int)

Converts a GDK edition number to its string representation.

Declaration
public static string Format(int editionNumber)
Parameters
Type Name Description
int editionNumber

The GDK edition number to convert.
Returns
Type Description
string

A formatted string representing the GDK edition.
Remarks

A GDK edition number alone does not provide sufficient information to know the edition type (generally "GDK" or "GDKX"). When the type can not be detected form the locally available editions the type will be shown as "GDK". Use Format(int editionNumber, string editionType) if more control is needed.

Format(int, string)

Formats a GDK edition number and type into a standardized string representation.

Declaration
public static string Format(int editionNumber, string editionType)
Parameters
Type Name Description
int editionNumber

The GDK edition number in the format YYMMUU where:

  • YY represents the last two digits of the year
  • MM represents the month (01-12)
  • UU represents the update number (00 when no update applies)
string editionType

The type of GDK edition (generally "GDK" or "GDKX").
Returns
Type Description
string

A formatted string in the pattern "Month 20YY editionType Update UU (editionNumber)". For example: "March 2023 GDKX Update 1 (230301)" or "June 2023 GDK (230600)".
Remarks

The method uses English (en-US) culture for month names regardless of the system's current culture. Update number is only included in the output if it's non-zero.

Format(GdkData)

Converts a GDK edition to its string representation.

Declaration
public static string Format(GdkData gdkData)
Parameters
Type Name Description
GdkData gdkData

The GDK data structure to convert.
Returns
Type Description
string

A formatted string representing the GDK data.