Command:
getFactorNote ( |
|
What:
Retrieves the notes associated with the factor whose name is passed as argument
Parameters:
name [char*] |
defines
the name of the factor interested. It must begin with a letter and can contain only letters and numbers, this parameter cannot be null! |
maxChar [integer] |
maximum
number of characters retrieved by the command from the field note |
note [char*] |
output
parameter containing the requested notes. In Matlab this parameter is not necessary |
Return:
error_code [int]: 1 if the operation has occurred without errors, 0 if an error has occurred
Warnings:
The command do not allocate memory for the note parameter, it has to be made by the user. The function will copy up to maxChar characters in note
Examples:
factor_note=getFactorNote('fac1', 5)
five characters of the notes of the factor called fac1 are copied in the Matlab variable factor_note- A Matlab example script using this command set_model_inputs.m