TipcConnGetUniqueSubject

Name

TipcConnGetUniqueSubject — get the unique subject of a connection’s peer process

Synopsis

T_BOOL TipcConnGetUniqueSubject(conn, unique_subject_return) 
T_IPC_CONN conn; 
T_STR *unique_subject_return; 

Arguments

conn — connection from which to get unique subject

unique_subject_return — storage for connection unique subject

Return Values

TRUE if the unique subject was successfully retrieved from the connection, FALSE otherwise.

Diagnostics

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

Description

TipcConnGetUniqueSubject gets the unique subject of a connection’s peer process (the process with which this process is communicating through the connection). The peer process unique subject can be useful for diagnostic purposes. The unique subject, which is used to uniquely identify a process, is stored in the option Unique_Subject.

Caution

If TipcConnGetUniqueSubject returns FALSE, it does not store a value in unique_subject_return.

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

See Also

TipcConnGetArch, TipcConnGetNode, TipcConnGetPid, TipcConnGetUser

Examples

This example prints the unique subject of a connection’s peer process:

T_STR unique_subject; 
 
if (!TipcConnGetUniqueSubject(conn, &unique_subject)) { 
  return;  /* error */ 
}  
TutOut("Connection peer process unique subject is <%s>.\n", 
       unique_subject);