You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Matrix Query 0x0097
SwitchKit Name
DeviceServerQuery
Type
EXS API and SwitchKit API message
Description
This message is sent by the Host to query details of set configuration data and the status of the IP Signaling Series 3 card interface.
NOTE: This message supports a feature of a Excel product other than SwitchKit. For that reason, the message is not to be used in a SwitchKit only environment.
Sent by
Host
SwitchKit Code
C Structure
typedef struct {
UBYTE AddrInfo[30];
UBYTE QueryType;
UBYTE Reserved;
} XL_DeviceServerQuery;
C Structure Response
typedef struct {
unsigned short Status;
UBYTE TLVCount;
UBYTE Data[250];
} XL_DeviceServerQueryAck;
C++ Class
class XLC_DeviceServerConfig : public XLC_OutboundMessage {
public:
const UBYTE *getAddrInfo() const;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
UBYTE getConfigType() const;
void setConfigType(UBYTE x);
UBYTE getTLVCount() const;
void setTLVCount(UBYTE x);
const UBYTE *getData() const;
UBYTE *getData();
void setData(UBYTE *x);
};
C++ Class Response
class XLC_DeviceServerQueryAck : public XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
UBYTE getTLVCount() const;
void setTLVCount(UBYTE x);
const UBYTE *getData() const;
UBYTE *getData();
void setData(UBYTE *x);
};
EXS API Hex Format
MESSAGE |
RESPONSE |
||
Byte |
Field Description |
Byte |
Field Description |
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
1, 2 |
Length (0xNNNN) |
1, 2 |
Length (0xNNNN) |
3, 4 |
Message Type (0x0097) |
3, 4 |
Message Type (0x0097) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Sequence Number (same as message) |
7 |
Logical Node ID |
7 |
Logical Node ID |
: |
Address Method 0x00 - Individual AEs |
8, 9
|
|
10 |
Number of TLVs to follow |
||
Number of AEs to follow |
|||
AEs |
|||
: |
Query Type 0x01 Query List of IP Signaling Series 3 Cards (NOTE: AIB is Null AIB) 0x02 Query IP Signaling Series 3 Card This returns for the IP Signaling Series 3 Card: 0x03 Query IP Signaling Series 3 Card 0x04 Query Gateways on this IP Signaling |
11 |
0x0001 Add IP Signaling Series 3 Card 0x0005 IP Signaling Series 3 Card IP Address |
: |
Reserved (0x00) |
: |
Response 0x0010 Positive Ack 0x1200 Invalid IP Signaling Series 3 Card ID 0x1201 Invalid Query Type 0x120C IP Signaling Series 3 cards are |
: |
Checksum |
: |
Checksum |