Click or drag to resize
RemoteServerToControlSystemUpdateProgressStruct Structure
This structure returned is used to populate the "AutoUpdateApi.RemoteServerToControlSystemUpdateProgressEventArgs" class.

Namespace: Crestron.AutoUpdateApiCommon
Assembly: SimplSharpAutoUpdateInterface (in SimplSharpAutoUpdateInterface.dll)
public struct RemoteServerToControlSystemUpdateProgressStruct

The RemoteServerToControlSystemUpdateProgressStruct type exposes the following members.

Public fieldautoUpdateAppNumber
The app number this came from.
Public fieldautoUpdateMessageFlagsFromAPI
General purpose bitfield. b0: 1: API is performing a Query. When the API sends the lower layer a query, the response to the query should have this bit set. This will indicate to the API that it should not fire an event. This will be used when the user tries to read a property (a query will be sent by the API, the API will wait for a timeout. The thread that reads from the queue will either fire an event or not based on this bit. 0: API is setting the given value. Lower layer when it responds should have this bit cleared, which means that the API will fire an event back to the programmer.
Public fieldautoUpdateMessageLength
Size of the structure, including itself [AutoUpdateConstants.RemoteServerToControlSystemUpdateProgressStructOverhead + CurrentFileNameBeingTransferredFromRemoteServer.Length]
Public fieldautoUpdateMessageType
Public fieldautoUpdateStatus
Status of the transfer: 0: Started, 1: Completed successfully, 2: Already Up to date. 100+: Failures This is propagated to the user via the eCurrentTransferStatus in the AutoUpdateEventArgs.cs file.
Public fieldCurrentFileNameBeingTransferredFromRemoteServer
This property gives the current file name being transferred from the RemoteServer to the control system.
Public fieldCurrentFileNameBeingTransferredFromRemoteServerLength
The length of the CurrentFileNameBeingTransferredFromRemoteServer field.
Public fieldCurrentFileNumberBeingTransferredFromRemoteServer
The current file number being transferred from the RemoteServer to the control system out of NumberOfFilesToGetFromRemoteServer total.
Public fieldNumberOfFilesToGetFromRemoteServer
The number of files that need to be transferred from Remote Server to the control system for device updates when the update runs.
See Also