DITA-FMx User Guide

AssignIdToElem

Runs the Assign ID to Element command on the selected or specified element.

Syntax

F_ApiCallClient("ditafmx", "AssignIdToElem[|docId|elemId]");
docId
FrameMaker ID of the document that contains the specified element. If not provided, the selected element in the current document is used. Optional.
elemId
FrameMaker ID of the element to assign the @id. If not provided, the selected element in the current document is used. Optional.
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 assign the ID to the specified element. 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 FrameMaker ID of the specified element.