Description

This function queries an ARN for its lock flag and returns a True or False indicating the result.  True means the ARN is locked.  False means the ARN is not locked.

Syntax

bLocked = ARNGetLocked( arnNode )

Parameters

bLocked (Boolean)

Return value indicating whether the ARN is locked (True) or not locked (False).

arnNode As Long

The node number of the ARN being queried.

Example

The following example loops over all ARN in the document, deletes any ARN that are not locked and then prints to the output window the number of ARN that were deleted.

Sub Main

    Dim curArn As Long, arnMaxNode As Long, delCount As Long

    Dim arnLock As Boolean

    delCount = 0

    arnMaxNode = ARNGetMaxNodeNum()

    For curArn = 0 To arnMaxNode

        If ARNIsValidNode( curArn ) Then

            arnLock = ARNGetLocked( curArn )

            If Not arnLock Then

                If ARNDelete( curArn ) Then

                    delCount += 1

                End If

            End If

        End If

    Next

    Print delCount & " unlocked ARN deleted."

End Sub

See Also

ARN Script Commands