You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > AppPopulationQuery
Type
SwitchKit API message
Purpose
Use the SK_AppPopulationQuery to query the application IDs of all applications connected to the Low-Level Communicator (LLC).
Description
The AppPopulationQuery message requires no arguments. The message is used for querying the application IDs of all applications connected to the LLC. All IDs are returned in the AppPopulationQueryAck message.
Sent by
Application
How to use
To use an AppPopulationQuery, construct the message with no argument:
SKC_AppPopulationQuery apq;
Status Field
The following table shows the possible return values of the status field:
Value |
Description |
---|---|
OK |
Query successful acknowledged. |
SK_NO_ACK_FROM_ |
The Excel platform did not respond. |
C Structure
typedef struct {
} SK_AppPopulationQuery;
C Structure Response
typedef struct {
int Status;
int NumApps;
int AppIDs[50];
} SK_AppPopulationQueryAck;
C++ Class
class SKC_AppPopulationQuery : public SKC_ToolkitMessage {
public:
};
C++ Class Response
class SKC_AppPopulationQueryAck : public SKC_ToolkitAck {
public:
int getStatus() const;
void setStatus(int x);
int getNumApps() const;
void setNumApps(int x);
const int *getAppIDs() const;
void setAppIDs(const int *x);
};