HypGetVersion

Data provider types: All

Description

HypGetVersion() retrieves any of the following information about the installed version of Smart View and creates a version information file:

Product version number
Build number
Build date
build version

Syntax

HypGetVersion (vtID, vtValueList, vtVersionInfoFileCommand)

ByVal vtID As Variant

ByRef vtValueList As Variant

ByVal vtVersionInfoFileCommand As Variant

Parameters

vtID: Input parameter; the ID for which the information is required; can be one of the following constants or strings or empty:

BUILD_DATE or "BUILD DATE"
BUILD_NUMBER or "BUILD NO"
BUILD_VERSION or "VERSION"
PRODUCT_ID or "PRODUCT" ID
Empty: If empty, the output list contains all information in the version information file with comma-separated values.

vtValueList: Output parameter; the array list or required value

vtVersionInfoFileCommand: Input parameter; a numerical command ID to save or launch the version information file if vtID is empty. Possible values:

0- Do nothing
1- Save the version information file
2- Launch the version information file

Return Value

Returns 0 if successful; otherwise, returns the appropriate error code

Examples

To create a message box that displays the build version:

Public Declare Function HypGetVersion Lib "HsAddin" (ByVal vtID As Variant, ByRef vtValueList As Variant, ByVal vtVersionInfoFileCommand As Variant) As Long
Sub Example_HypGetVersion() 
sts = HypGetVersion(BUILD_VERSION, version, 0) 
MsgBox version(0) 
End Sub

To retrieve and save version information in a version information file:

Public Declare Function HypGetVersion Lib "HsAddin" (ByVal vtID As Variant, ByRef vtValueList As Variant, ByVal vtVersionInfoFileCommand As Variant) As Long
Sub Example_HypGetVersion()
sts = HypGetVersion("", versioninfo, 1) 'saves version info file in user directory and gets array
inf = versioninfo(0) 'gets the information in 0th array element
End Sub