mdlIObject GetFullLocalLabel

Obtains the label of the child object.

Syntax

mdlIObject_handle GetFullLocalLabel or set, local_label_name [mdlIObject_handle GetFullLocalLabel]

Application

MotionView Tcl Query

Description

This command obtains the label of the child object. You need to grab the appropriate handle in order to get the desired label name. The local label is the label name assigned by the user when creating the object/entity.

Example

An MDL model must be loaded prior to using this command.

To get the local label of a body in a model:

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 BeginFlatListFastGet Body
myModelName GetChildHandleByIdx body_handle 2
set Body_Name [body_handle GetFullLocalLabel]
myModelName EndChildFastGet
body_handle ReleaseHandle
myModelName ReleaseHandle
myClientName ReleaseHandle
myWindowName ReleaseHandle
myPageName ReleaseHandle
myProjectName ReleaseHandle
mySessionName ReleaseHandle
hwi CloseStack

Errors

Returns the local label of the child object, which can be stored as a string in a variable or a list.