IServer Interface Reference

List of all members.

---

Detailed Description

Represents the whole COM server.

This is the top object of "ACI for Pro/E". It represents the COM server itself. Create it directly through standard COM means (such as New in Visual Basic or CoCreateInstance in C++) and then use it to access other objects.

Use it to:

• Get information about the COM server itself.
• Start Pro/E.

Contains:

• IProE

Instantiation

[Visual Basic .NET]

        Dim Server As New ProeServer.Server 

[C#]

        ProeServer.IServer server = new ProeServer.Server(); 

[nonmanaged C++]

        #import <progid:ProeServer.Server>
        // ...
        ProeServer::IServerPtr server(__uuidof(ProeServer::Server)); 

[Tcl]

        package require tcom
        set server [::tcom::ref createobject "ProeServer.Server"] 

Public Member Functions
HRESULT	CalcProCommMsgExe ([in, defaultvalue("")] BSTR in_command,[in, defaultvalue("")] BSTR in_pro_comm_msg_exe,[out, retval] BSTR *out_retval)
	Calculate a PRO_COMM_MSG_EXE value that will be used to start Pro/E.
HRESULT	CalcProECommand ([in, defaultvalue("")] BSTR in_command,[out, retval] BSTR *out_retval)
	Calculates a command that will be used to start Pro/E.
HRESULT	ConnectProE ([in, defaultvalue("")] BSTR in_proe_session_id,[in, defaultvalue(-1)] VARIANT_BOOL in_any_display,[in, defaultvalue("")] BSTR in_display,[in, defaultvalue(-1)] VARIANT_BOOL in_any_user,[in, defaultvalue("")] BSTR in_user,[in, defaultvalue(-1)] VARIANT_BOOL in_allow_random,[in, defaultvalue(10)] int in_timeout,[in, defaultvalue("")] BSTR in_pro_comm_msg_exe,[out, retval] VARIANT_BOOL *out_retval)
	Connects to already-running Pro/E.
HRESULT	DisconnectProE ()
	Disconnects from Pro/E and kills the corresponding object.
HRESULT	EAnnotationTypeToString ([in] enum EAnnotationType in_enum_value,[out, retval] BSTR *out_retval)
	Translates EAnnotationType value into human-readable string.
HRESULT	StartProE ([in, defaultvalue("")] BSTR in_command,[in, defaultvalue("")] BSTR in_parameters,[in, defaultvalue("")] BSTR in_pro_comm_msg_exe,[in, defaultvalue("")] BSTR in_proe_startup_dir,[in, defaultvalue(-1)] VARIANT_BOOL in_circumvent_windchill_bug,[out, retval] IProE **out_retval)
	Starts Pro/ENGINEER and sets IServer::ProE property.
HRESULT	StopProE ()
	Stops the Pro/ENGINEER and resets IServer::ProE property.
HRESULT	StringToEAnnotationType ([in] BSTR in_string_value,[out, retval] enum EAnnotationType *out_retval)
	Reverse of EAnnotationTypeToString().
Properties
BSTR	DebugLog [get]
	Absolute path to debug log.
BSTR	Exe [get]
	Absolute path to executable that implements this COM object.
IProE	ProE [get]
	Returns ProE object that can be used to access the Pro/ENGINEEER.
int	ProToolkitBuildVersion [get]
	Pro/TOOLKIT Wildfire version under which this COM server was built.
BSTR	RunDir [get]
	Directory that contains debug log and Pro/ENGINEER trail file.

---