/
windowExists

windowExists

Description

Determines whether or not a given docking window exists.

This is useful for custom GUI work inside of Shogun Post. This command can be used to check if a specified user window exists. This could be used before creating a user window to check if creating or destroying a window with a specified name would cause an error.

Functional area

User Window

Command syntax

Syntax

windowExists "windowName"

Arguments

NameTypeRequiredComments
windowNamestringyesThe name of the user window.

Flags

None

Return value

boolean

Examples

//code from AutoPropVST script
//check at start of operation for existence of the AutoPropVST window
//if it exists, destroy it so that it can be recreated in default form 
if(`windowExists "AutoPropVST"`)
{
    destroyWindow "AutoPropVST";
}

Additional information

Related commands


© Copyright Vicon Motion Systems. All rights reserved.

Vicon trademarks