Runs the Apply Ditaval command to filter the current
book or file.
Syntax
F_ApiCallClient("ditafmx", "ApplyDitaval |docOrBookIdOrName |ditavalName [| doClear [|filterType]]");
- docOrBookId
- Id or path and file name of document or book to process. You
must use double backslashes as the directory delimiter when specifying
the book or document file name. 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.
This value is ignored for a filterType of “2”
(filter by deletion). Use “1” to clear or “0” to persist any existing
conditions. Optional; default is 1 (clear).
- filterType
- Specifies the type of filtering to perform. Use “1” for filtering
with conditions or “2” for filtering by deletion. Optional; default
is 1 (filtering with conditions).
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.