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.
Syntax
F_ApiCallClient("DITAFMX", "LoadReferences[\tdocIdOrName]");
- docIdOrName
- The id or path and file name of the document to process. The
document must be open. Optional; if not provided the “active” document
is used.
Note: This DITA-FMx API function
is only available with “DITA-FMx-Auto.” For information on this
version of DITA-FMx, please contact Leximation.
Return Value
- 0
- 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”.
- -1
- Failure. Invalid docIdOrName.
- -2
- Failure. document is not a DITA file.
- >0
- Successfully updated the specified document (this is the value
of the docId processed).