NWCCGetConnRefInfo(3nw)

Synopsis

   #include <nwclxcon.h> 
   
 
   
 
   N_EXTERN_LIBRARY NWRCODE NWCCGetConnRefInfo 
     (nuint32        connRef, 
      nuint          infoType, 
      nuint          len, 
      nptr           buffer); 

Description

connRef

(IN) Specifies the connection reference for which to return the specified information.

infoType

(IN) Specifies the information to be returned about connRef.

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

0x880E

NWE_BUFFER_OVERFLOW

0x8864

NWE_INVALID_MATCH_DATA

0x8865

NWE_MATCH_FAILED

0x8866

NWE_NO_MORE_ENTRIES

0x8868

NWE_STRING_TRANSLATION

0x8869

NWE_ACCESS_VIOLATION

0x886B

NWE_INVALID_LEVEL

0x886C

NWE_RESOURCE_LOCK

Notices

NWCCGetConnRefInfo returns connection information from the NWCConnInfo structure associated with the given connection. NWCCGetConnRefInfo can either be set to return one field of the structure or the entire structure itself.

buffer must point to a buffer of the type of information being requested. (The return type is noted below for cache information.)

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

0x0007

NWCC_INFO_USER_ID

0x0008

NWCC_INFO_SERVER_NAME

0x0009

NWCC_INFO_TRAN_ADDR

0x0010

NWCC_INFO_NDS_STATE

0x0011

NWCC_INFO_MAX_PACKET_SIZE

0x0012

NWCC_INFO_LICENSE_STATE

0x0013

NWCC_INFO_DISTANCE

0x0014

NWCC_INFO_SERVER_VERSION

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 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	sizeof 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 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    sizeof 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_CAPABLE0

0x0001

NWCC_NDS_CAPABLE1

NWCC_INFO_LICENSE_STATE can return one of the following:

0x0000

NWCC_NOT_LICENSED

0x0001

NWCC_CONNECTION_LICENSED1

0x0002

NWCC_HANDLE_LICENSED2

Services

Connection