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

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

The AutoUpdateInitialInformationStruct 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. b1: 1: There is more device name data to be requested (filled in the DeviceNameBuffer field). // 2 0: No more device name data. b2: 1: This is the first "Initial Information" block // 4 0: This is not the first block.
Public fieldautoUpdateMessageLength
Size of the structure, including itself [AutoUpdateConstants.AutoUpdateInitialInformationStructOverhead + DeviceNameBuffer.Length]
Public fieldautoUpdateMessageType
Public fieldDeviceNameBuffer
This is a list of strings containing the devices that will receive updates; it will be used to populate the "AutoUpdateApi.InitialUpdateInformationEventArgs.DevicesFound" member. The buffer has items delineated by a "," Each name has a format similar to: This should have a format similar to "Slot-05.IP-ID-25.ID-AA.RF-ID-07:CLW-DIM-EX-P"
Public fieldDeviceNameBufferLength
The length of the DeviceNameBuffer field.
Public fieldNumberOfFilesToGetFromRemoteServer
This property gives the number of files that need to be transferred from Remote Server to the control system for device updates when the update runs.
Public fieldNumberOfFilesToSendFromControlSystemToDevices
This property gives the number of files that need to be transferred from the control system to various devices the update runs.
See Also