Manuais
PHC GO Funções SDK - System
 

Class System

This class contains functions that allow you to return information about the application.
 
 

GetAppID


Description

Gets the application´s ID.

Return Function

A string value that indicates the application´s ID.

Parameters

n/a

Example


Dim appID as string = SDK.System.GetAppID() 


Version


Description

Gets the application´s version.

Return Function

A string value that indicates the application´s version.

Parameters

n/a

Example


Dim version as string = SDK.System.Version() 


VersionMajor


Description

Gets the application´s major version.

Return Function

A string value that indicates the application´s major version.

Parameters

n/a

Example


Dim versionMajor as string = SDK.System.VersionMajor() 


VersionMinor


Description

Gets the application´s minor version.

Return Function

A string value that indicates the application´s minor version.

Parameters

n/a

Example


Dim versionMinor as string = SDK.System.VersionMinor() 


IsTrial


Description

Checks if the application is a Trial application.

Return Function

A logical value indicating whether or not the application is a trial application.

Parameters

n/a

Example


Dim isTrial as Boolean = SDK.System.IsTrial() 


IsKitParceiro


Description

Checks if the application is a KitParceiroDev application.

Return Function

A logical value indicating whether or not the application is a KitParceiroDev application.

Parameters

n/a

Example


Dim isKitParceiro as Boolean = SDK.System.IsKitParceiro() 


IsKitParceiroApp


Description

Checks if the application is a KitParceiro application.

Return Function

A logical value indicating whether or not the application is a KitParceiro application.

Parameters

n/a

Example


Dim isKitParceiroApp as Boolean = SDK.System.IsKitParceiroApp() 


License


Description

Gets the application´s license.

Return Function

A string value that indicates the application´s license.

Parameters

n/a

Example


Dim license as string = SDK.System.License() 


ExportDir


Description

Gets the application´s export directory.

Return Function

A string value that indicates the application´s export directory.

Parameters

n/a

Example


Dim exportDirectory as string = SDK.System.ExportDir() 


GetExportPath


Description

Gets the export path of a file.

Return Function

A string value that indicates the export path of a file.

Parameters


Name Description Type
filename File name String

Example


Dim exportPath as string = SDK.System.GetExportPath("filename.txt") 


GetCurrentEdition


Description

Gets the application´s current gama.

Return Function

The application´s current gama.

Parameters

n/a

Example


'Checks if applications gama is Pro 

Dim currentGama as Gamas = SDK.System.GetCurrentEdition()
If currentGama = Gamas.Pro
Return New MsgInfo("The applications gama is: Pro")

End If


IsEditionAvailable


Description

Checks if the gama is available.

Return Function

A logical value indicating whether or not the gama is avaiable.

Parameters


Name Description Type
gamaCheck The gama to be checked ENUM PHCLibrary.Gamas (Ready, Grow, Star, Pro, Expert)

Example


Dim isGamaGrowAvailable as Boolean = SDK.System.IsEditionAvailable(Gamas.Grow)


AppProducts


Description

Gets the list of application´s products.

Return Function

A list of integer with all application´s products.

Parameters

n/a

Example


'Checks if POS is available 

Dim productsList As List(Of Integer) = SDK.System.AppProducts()
If productsList.Contains(Products.POS) Then

Return New MsgInfo("POS is avaiable")
End If


IsProductLicence


Description

Checks if the product is available.

Return Function

A logical value indicating whether or not the product is avaiable.

Parameters


Name Description Type
productId The product to be checked Int32
or
ENUM PHCLibrary.Products (POS, VENDAS, STOCKS, COMPRAS, TESOURARIA, ANALISES, Agenda, UBLESPAP2_1, Documents, Equipamentos)

Example


Dim isProductDocumentLicense as boolean = SDK.System.IsProductLicence(Products. Documents) 


RecycleTrial


Description

Restarts PHC GO trial database. All released documents and activities will be deleted.

Return Function

PHCResult.

Parameters

n/a

Example


SDK.System.RecycleTrial()