XPRMgetannotations
XPRMgetannotations |
Purpose
Synopsis
int XPRMgetannotations(XPRMmodel model, const char *ident, const char *prefix, const char **ann, int maxann);
Arguments
|
model
|
Reference to a model
|
|
ident
|
Symbol to be considered or
NULL for global declarations
|
|
prefix
|
Filtering prefix
|
|
ann
|
Array of size
maxann where to store the annotations (can be
NULL)
|
|
maxann
|
Size of
ann (to get up to
maxann/2 annotations)
|
Return value
Size of the array required to get all annotations (two times the number of found annotations).
Further information
1. This function retrieves the annotations associated to the given symbol using a prefix as a filter (
e.g. use
"doc." to get all the documentation annotations). The result is stored in the provided array: each annotation occupies 2 entries in the array (the first one for the name of the annotation and the following one for its value).
2. The returned value may exceed
maxann (but no more than
maxann entries are recorded in the array). To get the required size for
ann the function may be called with a
NULL array.
Related topics