Parameters
Return Value
Remarks
Revisions
Example
See Also
Declaration
char* __stdcall getModelAbout( int line // indicates what information to return );
Parameters
- line
- One of the following values (defined in api2model.h):
- amName
- model name
- amVersion
- model version information
- amCopyright
- author's name and/or copyright
- amComments
- extra comments
- amUrl
- uniform resource locator (web address) for model
Return Value
A character string returning the appropriate information, depending on the line parameter. If the value of line is not recognized a default empty string ("") should be returned (for compatibility with future versions of the API which may ask for more information).Remarks
This optional function may be provided by the model. For each possible value of the parameter the function should return a character string indicating the appropriate information. The data is formatted and displayed in R2DToo's "About the Model" dialog box.Revisions
API v1.5- renamed from aboutModel.
Example