This class provides various product version information. More...

Inheritance diagram for Version:

Collaboration diagram for Version:

Static Public Member Functions
_.Library.Binary	FeatureBits (_.Library.Integer bit)
	This class provides various product version information. More...

_.Library.String	Format (_.Library.Numeric Format, _.Library.String zv)
	Formats the version info according to the following format types: More...

_.Library.String	GetBuildDate (_.Library.String zv)
	Returns the date the product was built in $HOROLOG format.

_.Library.Integer	GetBuildNumber (_.Library.String zv)
	Returns the build number for the product.

_.Library.String	GetBuildOS (_.Library.String zv)
	Returns the operating system for which the product was built.

_.Library.String	GetBuildTime (_.Library.String zv)
	Returns the time of day the product was built in $HOROLOG format.

_.Library.Integer	GetCompBuild (_.Library.String component)
	Returns the build number for the specified component. More...

_.Library.String	GetCompBuildDate (_.Library.String component)
	Returns the build date for the specified component. More...

_.Library.String	GetCompBuildOS (_.Library.String component)
	Returns the operating system a product component was built for. More...

_.Library.String	GetCompBuildTime (_.Library.String component)
	Returns the Time of build for a product component. More...

_.Library.String	GetCompPatchId (_.Library.String component)
	Returns the patch ID[s] included in a component of this version of the product (Deprecated)

_.Library.Numeric	GetCompilerMajorVersion ()
	Returns the major version number of the language compiler.

_.Library.Numeric	GetCompilerMinorVersion ()
	Returns the minor version number of the language compiler.

_.Library.Numeric	GetCompilerVersion ()
	Returns the major.minor version number of the language compiler. More...

_.Library.List	GetComponents ()
	Returns a list of components used by the Version class. More...

_.Library.String	GetISCComponentVersion (_.Library.Integer Product, _.Library.String Component)
	Returns the ISC Product component's installed version string. More...

_.Library.List	GetISCComponentVersionList (_.Library.Integer Product)
	Return a List of Component:Version for all components of ISC Product. More...

_.Library.List	GetISCComponents (_.Library.Integer Product)
	Returns the installed components for the ISC Product as a List. More...

_.Library.Integer	GetISCProduct ()
	Returns the installed ISC product code. More...

_.Library.String	GetKernelCompiler ()
	Returns the version of the C compiler used to build the kernel.

_.Library.String	GetKernelLinker ()
	Returns the version of the Linker used to link the kernel.

_.Library.String	GetKernelOrigin ()
	Returns the string identifying who linked the kernel. More...

_.Library.String	GetMajor (_.Library.String zv)
	Returns the major version number for the product.

_.Library.String	GetMinor (_.Library.String zv)
	Returns the minor version number for the product.

_.Library.String	GetNumber (_.Library.String zv)
	Returns the major.minor[.point] version number for the product.

_.Library.String	GetOS (_.Library.String zv)
	Returns the OS for which the product was built.

_.Library.String	GetPatchId (_.Library.String zv)
	Returns the patch ID[s] included in this version of the product;.

_.Library.String	GetPlatform (_.Library.String zv)
	Returns the platform for which the product was built.

_.Library.String	GetPoint (_.Library.String zv)
	Returns the point version number for the product.

_.Library.String	GetProduct (_.Library.String zv)
	Returns the product name.

_.Library.String	GetVersion (_.Library.String zv)
	Returns a string containing complete version information.

_.Library.Boolean	Is64Bits ()
	Is this a 64-bit platform? More...

_.Library.Boolean	IsBigEndian ()
	Is this system built for a big endian platform? More...

_.Library.Boolean	IsSingleUser ()
	Is this a single-user server kit? More...

_.Library.Boolean	IsUnicode ()
	Is this a UNICODE system? More...

	ListISCComponents (_.Library.Integer Product)
	Displays all Components for the ISC Product to the current I/O Device. More...

	ListISCComponentsVersions (_.Library.Integer Product)
	Displays all Components:Version for the ISC Product to the current I/O Device. More...

_.Library.String	SystemMode (_.Library.String mode)
	The SystemMode string is usually set by the System Management Portal but it. More...

Static Public Member Functions inherited from Help
_.Library.String	Help (_.Library.String method)
	This is a helper class that is used by the various SYSTEM classes to provide a Help method. More...

Detailed Description

This class provides various product version information.

You can use it via the special $system object:

Write $system.Version.GetBuildOS()

Member Function Documentation

◆ FeatureBits()

_.Library.Binary FeatureBits ( _.Library.Integer bit )

static

This class provides various product version information.

You can use it via the special $system object:

Write $system.Version.GetBuildOS()

Return all the feature codes stored in $zversion(0)

You can then test this for specific features using $zbitget(return,bit)

If you pass in a value for bit then this will test for this specific bit and return 1 if it is set otherwise 0.

◆ Format()

_.Library.String Format	(	_.Library.Numeric	Format,
		_.Library.String	zv
	)

static

Formats the version info according to the following format types:

0 - $ZV
1 - Product
2 - Product (Platform)
3 - Product (Platform) Version
4 - Product (Platform) Version (Build)
5 - Version (Build)
Other - ""

◆ GetCompBuild()

_.Library.Integer GetCompBuild ( _.Library.String component )

static

Returns the build number for the specified component.

(Deprecated)

◆ GetCompBuildDate()

_.Library.String GetCompBuildDate ( _.Library.String component )

static

Returns the build date for the specified component.

(Deprecated)

◆ GetCompBuildOS()

_.Library.String GetCompBuildOS ( _.Library.String component )

static

Returns the operating system a product component was built for.

(Deprecated)

◆ GetCompBuildTime()

_.Library.String GetCompBuildTime ( _.Library.String component )

static

Returns the Time of build for a product component.

(Deprecated)

◆ GetCompilerVersion()

_.Library.Numeric GetCompilerVersion ( )

static

Returns the major.minor version number of the language compiler.

The system can only execute object code compiled with the same major version number. It can execute object code compiled with any minor version number that is less than or equal to the current minor version.

◆ GetComponents()

_.Library.List GetComponents ( )

static

Returns a list of components used by the Version class.

(Deprecated)

◆ GetISCComponentVersion()

_.Library.String GetISCComponentVersion	(	_.Library.Integer	Product,
		_.Library.String	Component
	)

static

Returns the ISC Product component's installed version string.

Product: HealthShare = 3, InterSystems IRIS = 4
At this time, InterSystems IRIS does not have components, so this method does not return anything for this product.

◆ GetISCComponentVersionList()

_.Library.List GetISCComponentVersionList ( _.Library.Integer Product )

static

Return a List of Component:Version for all components of ISC Product.

At this time, InterSystems IRIS does not have components, so this method does not return anything for this product.

◆ GetISCComponents()

_.Library.List GetISCComponents ( _.Library.Integer Product )

static

Returns the installed components for the ISC Product as a List.

Product: HealthShare = 3, InterSystems IRIS = 4
At this time, InterSystems IRIS does not have components, so this method does not return anything for this product.

◆ GetISCProduct()

_.Library.Integer GetISCProduct ( )

static

Returns the installed ISC product code.

HealthShare = 3, InterSystems IRIS = 4

◆ GetKernelOrigin()

_.Library.String GetKernelOrigin ( )

static

Returns the string identifying who linked the kernel.

InterSystems or User

◆ Is64Bits()

_.Library.Boolean Is64Bits ( )

static

Is this a 64-bit platform?

Returns a boolean value which tells if the kernel is 64-bit platform.

◆ IsBigEndian()

_.Library.Boolean IsBigEndian ( )

static

Is this system built for a big endian platform?

Returns a boolean value which tells if the platform uses big endian bit ordering.

◆ IsSingleUser()

_.Library.Boolean IsSingleUser ( )

static

Is this a single-user server kit?

Returns a boolean value which tells if the product server is running a single-user evaluation (_SU) kit.

◆ IsUnicode()

_.Library.Boolean IsUnicode ( )

static

Is this a UNICODE system?

Returns a boolean value which tells if the product server is a UNICODE system.

◆ ListISCComponents()

ListISCComponents ( _.Library.Integer Product )

static

Displays all Components for the ISC Product to the current I/O Device.

Product: HealthShare = 3, InterSystems IRIS = 4
At this time, InterSystems IRIS does not have components, so this method does not return anything for this product.

◆ ListISCComponentsVersions()

ListISCComponentsVersions ( _.Library.Integer Product )

static

Displays all Components:Version for the ISC Product to the current I/O Device.

Product: HealthShare = 3, InterSystems IRIS = 4
At this time, InterSystems IRIS does not have components, so this method does not return anything for this product.

◆ SystemMode()

_.Library.String SystemMode ( _.Library.String mode )

static

The SystemMode string is usually set by the System Management Portal but it.

can also be set by calling the $SYSTEM.Version.SystemMode(mode) method. The currently supported SystemMode strings are: "LIVE", "TEST", "DEVELOPMENT" and "FAILOVER". The SystemMode of the current instance is displayed in the Title of the System Management Portal web page. Attempting to set a nonsupported SystemMode string will clear out the currently set SystemMode.

Parameters

mode – The new SystemMode string for the current instance

Invoking $SYSTEM.Version.SystemMode() without specifiying the mode parameter returns the current SystemMode string without changing it.

Return value – the SystemMode value prior to calling the $SYSTEM.Version.SystemMode method. Returns the empty string when a SystemMode has not been previously set.

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ FeatureBits()

◆ Format()

◆ GetCompBuild()

◆ GetCompBuildDate()

◆ GetCompBuildOS()

◆ GetCompBuildTime()

◆ GetCompilerVersion()

◆ GetComponents()

◆ GetISCComponentVersion()

◆ GetISCComponentVersionList()

◆ GetISCComponents()

◆ GetISCProduct()

◆ GetKernelOrigin()

◆ Is64Bits()

◆ IsBigEndian()

◆ IsSingleUser()

◆ IsUnicode()

◆ ListISCComponents()

◆ ListISCComponentsVersions()

◆ SystemMode()