getMembers
Retrieves the list of members available within the specified instance.
int getMembers(int RAMid, char instanceID[256],
Descriptor** memberArr, int* numRecords, void** params,
void*** customReturn, char filter[256], char error[256])
| Variable | Function | Description |
|---|---|---|
int RAMid |
Input | Tells CARMA which RAM should be worked on. This
ID was obtained after running getRAMList or getRAMList2. |
char instanceID[256] |
Input | The instance for which the members should be retrieved. |
Descriptor** memberArr |
Output | This will be allocated and filled with the IDs and names of instances. |
int* numRecords |
Output | The number of records that have been allocated and returned in the array. |
void** params |
Input | Pointer to an array of custom parameters (see Handling custom parameters and return values). |
void*** customReturn |
Output | Used to reference an array of custom return values (see Handling custom parameters and return values). |
char filter[256] |
Input | This can be passed from the client to filter out sets of members. |
char error[256] |
Output | If an error occurs, this should be filled with a description of the error. |
Note: Be sure to free the
memberArr array.