DITA-FMx User Guide


Updates the references in the specified or current file.

Use this function to update all references (xrefs, links, conrefs, and image references) in the specified file. Call this function using the “LoadReferences” parameter to update the active document, or pass the docIdOrName value (as a string) after this parameter to update a specific document.


F_ApiCallClient("ditafmx", "LoadReferences[|docIdOrName]");
The id or path and file name of the document to process. The document must be open. You must use double backslashes as the directory delimiter when specifying the document file name. Optional; if not provided the “active” document is used.
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

Failure. Unable to update the specified document. 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”.
Failure. Invalid docIdOrName.
Failure. document is not a DITA file.
Successfully updated the specified document (this is the value of the docId processed).