mdlIObject GetCandidateList

Gets the list of attachment candidates which can be resolved to an attachment based on the attachment tag.

Syntax

mdlIObject_handle GetCandidateList local_only

Application

MotionView Tcl Query

Description

This command obtains the list of attachment candidates based on the attachment tag.

Inputs

local_only
Argument can be ‘true’ or ‘false’.
True
Returns all resolved attachment candidate references
False
Returns all attachment candidates.

Example

To obtain the list of attachment candidates based on the attachment tag:
hwi OpenStack
hwi GetSessionHandle mySessionName 
mySessionName GetProjectHandle myProjectName 
set activePageNum [myProjectName GetActivePage]
myProjectName GetPageHandle myPageName $activePageNum
set activeWinNum [myPageName GetActiveWindow]
myPageName GetWindowHandle myWindowName $activeWinNum
myWindowName GetClientHandle myClientName 
myClientName GetModelHandle myModelName 
myModelName  InterpretEntity sys_handle System sys_0 \"System\" def_sys_0
sys_handle AddAttachment att_handle att_1 "\"Attachment 1\"" Body "RUN"
myModelName  InterpretEntity bd_handle Body b_0 \"Body 0\"
myModelName  InterpretEntity cand_handle AttachmentCandidate cand_1 "\"Test\"" b_0
myModelName InterpretSet SetAttachmentCandidateTag cand_1 "RUN"
myModelName  GetCandidateList false #It returns MODEL.sys_0._att1_att MODEL.b_0
myModelName ReleaseHandle
myClientName ReleaseHandle
myWindowName ReleaseHandle
myPageName ReleaseHandle
myProjectName ReleaseHandle
mySessionName ReleaseHandle
hwi CloseStack

Errors

Returns the candidate list if successful.