PropertyHandle :: Format - Get formatted string
The function returns a formatted string, where place holders are replaced by values of the current instance or values evaluated from expressions. The function requires a selected instance. When no instance is selected, the function returns NULL.
Parameters passed in the parameter list are interpreted in three steps:
- The parameter is checked to be an attribute. In this case, the attribute value is replaced in the format string.
- The parameter is checked to be an option. In this case, the option value replaces the place holder in the format string.
- The passed value replaces the place holder.
The function returns a 0-terminated string, which is stored in the property handles work area. This might be destroyed after calling the next property handle function with the current property handle.
Return value: String object ( NString & )
Implementation details
const NString &
PropertyHandle  :: Format ( NString &fstring, char **parm_list, int16 parm_count )
- fstring - Format string
- parm_list - Parameter list
- parm_count
- Number of passed parameters
The value contains the number of parameters in a parameter list passed to an action or function. Parameters in the list might have NULL values.