ApplyDitaval

Runs the Apply Ditaval as Conditions command.

Syntax

F_ApiCallClient("DITAFMX", "ApplyDitaval\tdocOrBookIdOrName\tditavalName[\tdoClear]");
docOrBookId
Id or path and file name of document or book to process. Required.
ditavalName
Name of the ditaval file as shown in the DITA-FMx Ditaval Manager. Required.
doClear
Indicates if existing conditions should be cleared or left alone. Enter “1” to clear or “0” to persist any existing conditions. Optional; default is 1 (clear).
Note: This DITA-FMx API function is only available when the “FMx-Auto” addon is installed. For information on this DITA-FMx addon, please contact Leximation.

Return Value

0
Failure. Unable to process the specified document or book. It is also possible that DITA-FMx is not available for calls. Verify that DITA-FMx is registered in the maker.ini file using the client name of “ditafmx”.
<0
Failure.
>0
Success. Value returned represents the number of conditions applied.