Click or drag to resize
AutoUpdateStringValueStruct Structure
This is used to send/receive a string value between the C# layer and the Auto Update manager layer. Any of the values from AutoUpdateMessageTypes can be used that are commented with "String Type."

Namespace: Crestron.AutoUpdateApiCommon
Assembly: SimplSharpAutoUpdateInterface (in SimplSharpAutoUpdateInterface.dll)
Syntax
C#
public struct AutoUpdateStringValueStruct

The AutoUpdateStringValueStruct type exposes the following members.

Fields
  NameDescription
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. Specifics for GenerateDeviceLists: b1: 1: There is more device name data to be requested (filled in the autoUpdateValue field). // 2 0: No more device name data. b2: 1: This is the first block of data // 4 0: This is not the first block. b3: 1: All Devices // 8 0: Filtered by Manifest
Public fieldautoUpdateMessageLength
Size of the structure, including itself [AutoUpdateConstants.StringStructOverhead + autoUpdateValue.Length]
Public fieldautoUpdateMessageType
Public fieldautoUpdateValue
A value for the specific type.
Top
See Also