Initializing help system before first use

getannotations

Purpose
Retrieve annotations of a model.
Synopsis
int getannotations(XPRMcontext ctx, const char *ident, const char *prefix, const char **ann, int maxann);
Arguments
ctx 
Mosel's execution context
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
getnextanident.

Parent Topic Dictionary access

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.