Base64ArrayHandOffResponse Class

JSON Response returned when base64 encoding will be used to return an image array

Definition

Namespace: ASCOM.Common.Alpaca
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class Base64ArrayHandOffResponse : ImageArrayResponseBase
Inheritance
Object    ErrorResponse    Response    ImageArrayResponseBase    Base64ArrayHandOffResponse

Constructors

Base64ArrayHandOffResponseInitializes a new instance of the Base64ArrayHandOffResponse class

Properties

ClientTransactionID Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.
(Inherited from Response)
Dimension0Length The length of the image array's X dimension: Array[X , Y] or Array[X, Y, Z]
Dimension1Length The length of the image array's Y dimension: Array[X , Y] or Array[X, Y, Z]
Dimension2Length The length of the image array's Z dimension if present. Returns 0 for a two dimension array: Array[X , Y]. Or >=1 for a three dimension array: Array[X , Y, Z]
DriverException Optional field for Windows drivers to return an exception to the client application.
(Inherited from ErrorResponse)
ErrorMessage Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned, a non zero ErrorNumber must also be returned.
(Inherited from ErrorResponse)
ErrorNumber Zero for a successful transaction, or a non-zero integer(-2147483648 to 2147483647) if the device encountered an issue.Devices must use ASCOM reserved error numbers whenever appropriate so that clients can take informed actions. E.g.returning 0x401 (1025) to indicate that an invalid value was received.
(Inherited from ErrorResponse)
Rank Array rank
(Inherited from ImageArrayResponseBase)
ServerTransactionID Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.
(Inherited from Response)
Type Array type
(Inherited from ImageArrayResponseBase)

Version Information

.NET Standard

Supported in: 2.0

See Also