TipcSrvConnGetUser

Name

TipcSrvConnGetUser — get the user name of the connection handle to RTserver

Synopsis

T_BOOL TipcSrvConnGetUser(srv, user_return) 
T_IPC_SRV srv; 
T_STR *user_return; 

Arguments

srv — connection handle to RTserver

user_return — storage for RTserver user name

Return Values

TRUE if the user name was successfully retrieved from the connection handle to RTserver, FALSE otherwise.

Diagnostics

If TipcSrvConnGetUser fails, it returns FALSE and sets the global SmartSockets error number to one of:

Description

TipcSrvConnGetUser gets the user name of the RTserver this RTclient is connected to by calling TipcConnGetUser. The RTserver username can be useful for diagnostic purposes. There is some overlap between TipcSrvConnGetUser and TipcSrvMonServerGeneralPoll, but TipcSrvConnGetUser is easier to use if only the user name is needed instead of all RTserver general information.

TipcSrvConnGetUser may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvConnGetUser does not use the warm connection, because the warm connection does not have a peer process with a user name. See TipcSrvConnOpen for more information on automatic creation of connections and warm connections to RTserver.

Caution

If TipcSrvConnGetUser returns FALSE, it does not store a value in user_return.

The value stored in user_return points directly into an internal data structure and should not be modified.

See Also

TipcConnGetUser, TipcSrvMonServerGeneralPoll, TipcSrvConnGetArch, TipcSrvConnGetNode, TipcSrvConnGetPid, TipcSrvConnGetUniqueSubject

Examples

This example retrieves and prints the user name of the connected RTserver:

T_IPC_SRV srv; 
T_STR user_return; 
 
if (!TipcSrvConnGetUser(srv, &user_return)) { 
  return;  /* error */ 
} 
TutOut("RTserver user name is <%s>.\n", user_return);