LoadReferences

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 docId value (as a string) after this parameter to update a specific document.

Syntax

F_ApiCallClient("DITAFMX", "LoadReferences [docId]");

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 docId.
-2
Failure. document is not a DITA file.
>0
Successfully updated the specified document (this is the value of the docId processed).