getCAFData
Retrieves the CAF data for the requested RAM.
int getCAFData(int RAMid, Action** actions, int* numActions,
int** disabledActions, int* numDisabled,
Parameter** params, int* numParams,
returnValue** returnVals, int* numReturn,
char error[256])
Variable | Function | Description |
---|---|---|
int RAMid |
Input | Tells CARMA for which RAM the CAF data should
be pulled. This ID was obtained after running getRAMList . |
Action** actions |
Output | This will be allocated and filled with the custom actions for the given RAM. |
int* numActions |
Output | The number of actions being returned. |
int** disabledActions |
Output | This will be allocated and filled with the disabled actions for the given RAM. |
int* numDisabled |
Output | The number of disabled actions being returned. |
Parameter** params |
Output | This will be allocated and filled with the custom parameters for the given RAM. |
int* numParams |
Output | The number of parameters being returned. |
returnValue** returnVals |
Output | This will be allocated and filled with the custom return values for the given RAM. |
int* numReturn |
Output | The number of return values being returned. |
char error[256] |
Output | If an error occurs, this should be filled with a description of the error. |
See Customizing a RAM API using the CAF for more information on the types of data that may be returned. The data that is returned should be stored for the remainder of the session so that it can be checked before any function call for the respective RAM.