mdlIModelClient GetGlobalOption

Syntax

mdlIModelClient_Handle GetGlobalOption option

Application

MotionView Tcl Query

Description

This command retrieves a global option for all MotionView clients. A global option is an option that spans all model clients. For example, when you set an option in one model client and retrieve it in another model client, it reflects what you set in the first model client. This command can be viewed as a way to retrieve some of the user preferences (which can be set using the SetGlobalOption command).

Inputs

option

Any option that is listed in mdlIModelClient SetGlobalOption.

Example

hwi GetSessionHandle sess1
sess1 GetProjectHandle pro1
pro1 GetPageHandle pa1 [pro1 GetActivePage]
pa1 GetWindowHandle win1 [pa1 GetActiveWindow]
win1 GetClientHandle mcl
mcl GetGlobalOption foreground_idx
mcl GetGlobalOption background_idx
mcl ReleaseHandle;
win1 ReleaseHandle;
pa1 ReleaseHandle;
pro1 ReleaseHandle;
sess1 ReleaseHandle;

Errors

Returns the value of the key 'option'. If there is an error, an error code will be returned.