FX3ApiInfo Class |
This class provides a collection of information about the FX3 API. All the fields are hard-coded into the DLL at compile time.
To retrieve the FX3ApiInfo set during compile time, use the GetFX3ApiInfo call within FX3 connection.
Inheritance HierarchyNamespace: FX3Api
Assembly: FX3Api (in FX3Api.dll) Version: 2.9.4.0 (2.9.4)
SyntaxThe FX3ApiInfo type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FX3ApiInfo |
Constructor which initializes values to "Error: Not Set"
|
Properties| Name | Description | |
|---|---|---|
 | GitBranch |
The branch which this version of the FX3Api was built on.
|
| GitCommitSHA1 |
The hast for the git commit which this version of the FX3Api was built on.
|
| GitCommitURL |
The URL of the git commit which this version of the FX3Api was built on.
|
| GitURL |
The base git remote URL which this version of the FX3Api was build on.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString |
Overload of the toString function to allow for better formatting.
(Overrides ObjectToString.) |
Fields| Name | Description | |
|---|---|---|
 | BuildDateTime |
The date and time of the current FX3Api build in use.
|
| Description |
The project description
|
| Name |
The project name (should be FX3Api)
|
| VersionNumber |
The build version of this FX3Api instance. Should match application firmware.
|
See Also