NWCCGetConnInfo(3nw)

NWCCGetConnInfo -- returns information about the specified connection

Synopsis

#include <nwclxcon.h>

N_EXTERN_LIBRARY NWRCODE NWCCGetConnInfo (NWC_CONN_HANDLE connHandle, nuint infoType, nuint len, nptr buffer);

Description

The parameters are as follows:

connHandle: (IN) Specifies the connection handle for which to return information.
infoType: (IN) Specifies the information to be returned about the connection specified in connHandle.
len: (IN) Specifies the length of the information buffer to be returned.
buffer: (OUT) Points to a buffer containing the returned information.

Return values

0x0000: SUCCESS
0x8801: NWE_CONN_INVALID
0x8868: NWE_STRING_TRANSLATION
0x8869: NWE_ACCESS_VIOLATION
0x886B: NWE_INVALID_LEVEL

Notices

NWCCGetConnInfo returns a single piece of connection information for the specified connection. It is important that the size of buffer is large enough to contain the requested information.

infoType must be set to indicate the type of data desired with the following values:

HEX Value Minimum buffer size/description

0x0001 NWCC_INFO_AUTHENT_STATE nuint; returns Authentication state

0x0002 NWCC_INFO_BCAST_STATE nuint; returns Broadcast state

0x0003 NWCC_INFO_CONN_REF nuint32; returns connection reference

0x0004 NWCC_INFO_TREE_NAME nstr * length of NWA_MAX_TREE_NAME_LEN); returns NDS tree name

0x0005 NWCC_INFO_CONN_NUMBER nuint; returns connection number

0x0006 NWCC_INFO_USER_ID nuint32

0x0007 NWCC_INFO_SERVER_NAME nstr * length of NWA_MAX_SERVER_NAME_LEN

0x0008 NWCC_INFO_NDS_STATE nuint

0x0009 NWCC_INFO_MAX_PACKET_SIZE nuint

0x0010 NWCC_INFO_LICENSE_STATE nuint

0x0011 NWCC_INFO_DISTANCE nuint

0x0012 NWCC_INFO_SERVER_VERSION size of NWCCVersion

HEX	Value	Minimum buffer size/description
0x0001	NWCC_INFO_AUTHENT_STATE	nuint; returns Authentication state
0x0002	NWCC_INFO_BCAST_STATE	nuint; returns Broadcast state
0x0003	NWCC_INFO_CONN_REF	nuint32; returns connection reference
0x0004	NWCC_INFO_TREE_NAME	nstr * length of NWA_MAX_TREE_NAME_LEN); returns NDS tree name
0x0005	NWCC_INFO_CONN_NUMBER	nuint; returns connection number
0x0006	NWCC_INFO_USER_ID	nuint32
0x0007	NWCC_INFO_SERVER_NAME	nstr * length of NWA_MAX_SERVER_NAME_LEN
0x0008	NWCC_INFO_NDS_STATE	nuint
0x0009	NWCC_INFO_MAX_PACKET_SIZE	nuint
0x0010	NWCC_INFO_LICENSE_STATE	nuint
0x0011	NWCC_INFO_DISTANCE	nuint
0x0012	NWCC_INFO_SERVER_VERSION	size of NWCCVersion

 
 ------------------------------------------------------------------ 
| HEX       |  Value                    |  Minimum buffer         | 
|           |                           |  size/description       | 
|-----------|---------------------------|-------------------------| 
| 0x0001    |  NWCC_INFO_AUTHENT_STATE  |  nuint; returns         | 
|           |                           |  Authentication state   | 
|-----------|---------------------------|-------------------------| 
| 0x0002    |  NWCC_INFO_BCAST_STATE    |  nuint; returns         | 
|           |                           |  Broadcast state        | 
|-----------|---------------------------|-------------------------| 
| 0x0003    |  NWCC_INFO_CONN_REF       |  nuint32; returns       | 
|           |                           |  connection reference   | 
|-----------|---------------------------|-------------------------| 
| 0x0004    |  NWCC_INFO_TREE_NAME      |  nstr * length of       | 
|           |                           |  NWA_MAX_TREE_NAME_LEN);| 
|           |                           |  returns NDS tree       | 
|           |                           |  name                   | 
|-----------|---------------------------|-------------------------| 
| 0x0005    |  NWCC_INFO_CONN_NUMBER    |  nuint; returns         | 
|           |                           |  connection number      | 
|-----------|---------------------------|-------------------------| 
| 0x0006    |  NWCC_INFO_USER_ID        |  nuint32                | 
|-----------|---------------------------|-------------------------| 
| 0x0007    |  NWCC_INFO_SERVER_NAME    |  nstr * length of       | 
|           |                           |  NWA_MAX_SERVER_NAME_LEN| 
|-----------|---------------------------|-------------------------| 
| 0x0008    |  NWCC_INFO_NDS_STATE      |  nuint                  | 
|-----------|---------------------------|-------------------------| 
| 0x0009    |  NWCC_INFO_MAX_PACKET_SIZE|  nuint                  | 
|-----------|---------------------------|-------------------------| 
| 0x0010    |  NWCC_INFO_LICENSE_STATE  |  nuint                  | 
|-----------|---------------------------|-------------------------| 
| 0x0011    |  NWCC_INFO_DISTANCE       |  nuint                  | 
|-----------|---------------------------|-------------------------| 
| 0x0012    |  NWCC_INFO_SERVER_VERSION |  size of NWCCVersion    | 
|-----------|---------------------------|-------------------------|

NWCC_INFO_AUTHENT_STATE can return one of the following:

0x0000: NWCC_AUTHENT_STATE_NONE
0x0001: NWCC_AUTHENT_STATE_BIND
0x0002: NWCC_AUTHENT_STATE_NDS

NWCC_BCASTSTATE can return one of the following:

0x0000: NWCC_BCAST_PERMIT_ALL
0x0001: NWCC_BCAST_PERMIT_SYSTEM
0x0002: NWCC_BCAST_PERMIT_NONE
0x0003: NWCC_BCAST_PERMIT_POLL

NWCC_INFO_NDS_STATE can return one of the following:

0x0000: NWCC_NDS_NOT_CAPABLE
0x0001: NWCC_NDS_CAPABLE

NWCC_INFO_LICENSE_STATE can return one of the following:

0x0000: NWCC_NOT_LICENSED
0x0001: NWCC_CONNECTION_LICENSED
0x0002: NWCC_HANDLE_LICENSED

Services

Connection