composer_get_all_parameters
composer_get_all_parameters(arr, type[, doc])
The composer_get_all_parameters function populates an array arr with all the parameters associated with the publishing type. The type parameter specifies a composer type. The type is specified by the Compose element's type attribute in the DCF file for doc.
The doc parameter specifies the document for which the composer is being created. If doc is not specified, the current document is used.
The resulting array is an associative array where each index is a name of a composer interface parameter, as defined by the Parameter element in the DCF file for the specified publishing type or by the Parameter element in the associated CCF file.
The entry at each index is the parameter's default value, with the default values in the DCF file taking precedence. If a parameter has no default value in the DCF or CCF file, the entry is an empty string.
As a special case, the document parameter is added to the array and given the value of doc.
The return value is the size of the populated array, or zero on failure.
|
|
Calling this function requires parsing the CCF file, unless the CCF file has been cached. Subsequent changes to the CCF will not be seen unless the composer is flushed by a call to the composer_flush function.
|
