TipcSrvConnGetCurrentConnectedLcn

Name

TipcSrvConnGetCurrentConnectedLcn — get the logical connection name of the connected RTserver

Synopsis

T_BOOL TipcSrvConnGetCurrentConnectedLcn(srv, lcn_return) 
T_IPC_SRV srv; 
T_STR lcn_return; 

Arguments

srv — connection handle to RTserver

lcn_return — storage for RTserver logical connection name

Return Values

TRUE if logical connection name was successfully retrieved, FALSE otherwise.

Diagnostics

If TipcSrvConnGetCurrentConnectedLcn fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcSrvConnGetCurrentConnectedLcn gets the logical connection name of the RTserver to which this RTclient is connected. If the function cannot find the logical connection name, it stores the string Unknown in lcn_return.

Caution

There is no way to know ahead of time how much storage is needed for lcn_return.

The value of lcn_return cannot be NULL. Storage for lcn_return must be managed by the caller.

If TipcSrvConnGetCurrentConnectedLcn returns FALSE, it does not store a value in lcn_return.

See Also

TipcSrvGetCurrentConnectedLcn

Examples

This example prints the name of the logical connection name of RTserver:

T_IPC_SRV srv; 
T_CHAR lcn[80]; 
 
if (!TipcSrvConnGetCurrentConnectedLcn(srv, lcn)) { 
  return;  /* error */ 
} 
 
TutOut("Current Logical Connection Name is <%s>\n", lcn);