DEPRECATED: | Since Creo 2 | ||||
SUPERSEDED BY: | ProEngineerConnect | ||||
Description | |||||
NOTE: This function is deprecated. Pro/INTRALINK 3.4 is not supported. Please use ProEngineerConnect() to connect to Creo Parametric process that has a Pro/INTRALINK 10.0 server registered. Causes the Creo Parametric TOOLKIT program to connect to an existing Creo Parametric process running on a host using a specified display. It is intended for use in simple and full asynchronous modes. |
|||||
Synopsis | |||||
#include <ProCore.h> | |||||
ProError | ProEngineerConnectWS | ( | |||
char* proe_session_id | |||||
/* (In) | |||||
This argument can be either an empty string or an identification string returned by ProEngineerConnectIdExtract. If it is an ID string, the Creo Parametric TOOLKIT application will try to connect to the specified Creo Parametric session; if this attempt fails, the application will try to connect to any Creo Parametric session. | |||||
*/ | |||||
char* display | |||||
/* (In) | |||||
The name of the display Creo Parametric is using. If this is NULL, match any display. If this is an empty string, assume the local host. | |||||
*/ | |||||
char* user | |||||
/* (In) | |||||
The name of the user running the Creo Parametric to connect to. If this is NULL, match any user. If this is an empty string, assume the current user. | |||||
*/ | |||||
wchar_t* workspace | |||||
/* (In) | |||||
The name of the workspace Creo Parametric is using. If this is NULL, match any workspace. | |||||
*/ | |||||
char* textpath | |||||
/* (In) | |||||
The path under which the Creo Parametric TOOLKIT message and menu files are held. This is used in full asynchronous mode only. Otherwise, pass a null string. | |||||
*/ | |||||
ProBoolean allow_random | |||||
/* (In) | |||||
If this is PRO_B_TRUE, and more than one Creo Parametric is running on the host using the specified display, choose one at random and connect to it. If this is PRO_B_FALSE, return an error in this case. | |||||
*/ | |||||
unsigned int timeout_sec | |||||
/* (In) | |||||
The time, in seconds, to wait for Creo Parametric to respond to the connection request. | |||||
*/ | |||||
ProBoolean* random_choice | |||||
/* (Out) | |||||
If this is PRO_B_TRUE, more than one Creo Parametric met the specified criteria (allow_random was TRUE) and the function arbitrarily chose one Creo Parametric session. | |||||
*/ | |||||
ProProcessHandle* p_handle | |||||
/* (Out) | |||||
A pointer to a process handle to be used in subsequent calls to Creo Parametric. | |||||
*/ | |||||
) | |||||
Returns | |||||
|
|||||
See Also | |||||
ProEngineerConnect |