Category Windchill servers, Object ProServer

Function ProServerAliasGet


Description
Gets the alias for a given codebase url and workspace.
Replacement in Object TOOLKIT: pfcBaseSession::GetServerByUrl
pfcBaseSession::GetServerLocation
Synopsis
#include <ProWTUtils.h>
ProErrorProServerAliasGet(
wchar_t* url
/* (In)
The arbitrary url of the server.
*/
wchar_t* ws_name
/* (In)
The workspace on the server. Could be NULL
*/
wchar_t** alias
/* (Out)
The alias of the server. If workspace is NULL and more then one server with the url is registered, returns alias of one of the registered servers. Free this string using ProWstringFree().
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more inputs was invalid.
PRO_TK_E_NOT_FOUNDThe server was not registered.
PRO_TK_GENERAL_ERRORIf any other error occures.

Manual References:

  1. Data Management: Windchill Operations: Accessing Information From a Registered Server
  2. Data Management: Windchill Operations: Accessing Information From a Registered Server