#include <IServerSettings.h>

Inheritance diagram for IServerSettings:

Public Types
enum	{ kDefaultIID = IID_ISERVERSETTINGS }

Public Member Functions
virtual void	SetImagePreview (bool16 imagePreview)=0

virtual bool16	GetImagePreview ()=0

virtual void	SetJavaScriptUI (bool16 javaScriptUI)=0

virtual bool16	GetJavaScriptUI ()=0

virtual bool16	GetHasConsole ()=0

virtual PMString	GetIORFile ()=0

virtual bool16	GetLogToEventLog ()=0

virtual int32	GetMaxErrors ()=0

virtual void	SetMaxErrors (int32 maxErrors)=0

virtual PMString	GetPluginPath ()=0

virtual bool16	GetSendCrashLogs ()=0

virtual bool16	GetUseErrorList ()=0

virtual void	SetUseErrorList (bool16 buseErrorList)=0

virtual bool16	GetUseSEH ()=0

virtual int32	GetPortNumber ()=0

virtual PMString	GetConfigurationName ()=0

virtual bool16	GetOnMainThreadExecutionMode ()=0

virtual bool16	IsSessionSupportLoggingEnabled ()=0

virtual int32	GetSessionTimeout ()=0

virtual int32	GetAdminPortNumber ()=0

virtual int32	GetHeartbeatUpdateInterval ()=0

virtual PMString	GetHostName ()=0

virtual bool16	IsSessionSupportNonBlocking ()=0

virtual void	SetIsSessionSupportNonBlocking (bool16 bSSNonBlocking)=0

virtual uint16	GetMaximumWaitForBeginSession ()=0

virtual void	SetMaximumWaitForBeginSession (uint16 inMaxWaitTime)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Settings used by InDesign Server to increase performance and control UI for debugging.

The undo state is referenced when creating new documents and is used to control the document's command mgr undo state. Changing the undo state with IServerSettings has no effect on the current undo state of a document, only new ones. By default the undo state is kFalse for increased performance.

The image preview state is referenced during import of images and determines whether a preview will be generated for the newly imported image. If the document being created will not be opened by an end user in InDesign than there are significant advantages to turning of image preview support. With image previews turned off graphics will appear in InDesign as gray boxes until re-linked. By default, image previews are turned off in the server.

The JavaScript UI setting controls whether JavaScript native dialogs will display. Sometimes it is useful while debugging to have access to these dialogs. By default JavaScript UI is turned off in the Server.

Member Function Documentation

virtual int32 IServerSettings::GetAdminPortNumber ( )

pure virtual

Which port is open for admin messages?

Returns: port number for administration messages. A return of -1 indicates no port.

virtual PMString IServerSettings::GetConfigurationName ( )

pure virtual

What is configuration name is being used?

Returns: name of the configuration provided on the command line or a name constructed based on the current port number.

virtual bool16 IServerSettings::GetHasConsole ( )

pure virtual

Did this instance of InDesignServer start a console window?

Returns: kTrue if this instance of InDesignServer started a console window. The default value is kFalse.

virtual int32 IServerSettings::GetHeartbeatUpdateInterval ( )

pure virtual

Returns: interval at which last active timestamp of IDS is sent to IDS console application

virtual PMString IServerSettings::GetHostName ( )

pure virtual

What is the host name this instance is running on?

Returns: name of the host either as DNS style name (foo.bar.com) or IP (123.456.78.90).

virtual bool16 IServerSettings::GetImagePreview ( )

pure virtual

Get the value of the image preview state.

Returns: kTrue if image previews are enabled. The default value is kFalse.

virtual PMString IServerSettings::GetIORFile ( )

pure virtual

Get the path to the IOR file.

Returns: path to the IOR file. The default value is an empty string.

virtual bool16 IServerSettings::GetJavaScriptUI ( )

pure virtual

Get the value of the JavaScript UI state.

Returns: kTrue if JavaScript UI is displayable. The default value is kFalse.

virtual bool16 IServerSettings::GetLogToEventLog ( )

pure virtual

Is this instance logging to the event log?

Returns: kTrue if this instance is logging to the event log. The default value is kFalse.

virtual int32 IServerSettings::GetMaxErrors ( )

pure virtual

Get the maximum size of the error list.

Returns: maximum size of the error list. Default is 10000.

virtual uint16 IServerSettings::GetMaximumWaitForBeginSession ( )

pure virtual

Returns: maximum wait time in secs for begin session to take place in case of non-blocking begin session requests

virtual bool16 IServerSettings::GetOnMainThreadExecutionMode ( )

pure virtual

Returns: true if all client requests are executed on main thread only

virtual PMString IServerSettings::GetPluginPath ( )

pure virtual

Get the string of paths to additional plugin directories.

Returns: paths of additional plugin directories. The default value is an empty string.

virtual int32 IServerSettings::GetPortNumber ( )

pure virtual

Which port is IDS listening on for SOAP messages?

Returns: port number IDS is listening on. A return of -1 indicates no port.

virtual bool16 IServerSettings::GetSendCrashLogs ( )

pure virtual

Will crashes cause crash logs to be sent to Adobe?

Returns: kTrue if a crash will automatically send crash logs to Adobe. The default value is kFalse.

virtual int32 IServerSettings::GetSessionTimeout ( )

pure virtual

Returns: session timeout in seconds

virtual bool16 IServerSettings::GetUseErrorList ( )

pure virtual

Should errors be saved in the error list?

Returns: kTrue if errors should be saved in the error list. The default value is kFalse.

virtual bool16 IServerSettings::GetUseSEH ( )

pure virtual

Did a structured event handler get installed on launch?

Returns: kTrue if a structured event handler got installed on launch. The default value is kTrue.

virtual bool16 IServerSettings::IsSessionSupportLoggingEnabled ( )

pure virtual

Returns: true if Session Support logging is enabled

virtual bool16 IServerSettings::IsSessionSupportNonBlocking ( )

pure virtual

Returns: kTrue if a BeginSession request should be non blocking

virtual void IServerSettings::SetJavaScriptUI ( bool16 javaScriptUI )

pure virtual

Set the value of JavaScript UI. Setting the state to kTrue will allow JavaScript native UI dialogs to be displayed.

Parameters

javaScriptUI indicates whether JavaScript native UI dialogs will be displayed.

virtual void IServerSettings::SetMaxErrors ( int32 maxErrors )

pure virtual

Set the maximum size of the error list.

Parameters

maxErrors maximum size the error list can grow to

virtual void IServerSettings::SetMaximumWaitForBeginSession ( uint16 inMaxWaitTime )

pure virtual

Parameters

inMaxWaitTime wait time in secs for non blocking begin session

virtual void IServerSettings::SetUseErrorList ( bool16 buseErrorList )

pure virtual

Set the value of the Use Error List state.

Parameters

if	kTrue, errors up to the value set via SetMaxErrors are saved. The default value is kFalse.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation