NetAccessGetInfo or Net32AccessGetInfo

The NetAccessGetInfo API retrieves information about the access permission record of a resource. This API returns the data structures described in Resource Access Data Structures. It can return either an access_info_0 data structure or an access_info_1 data structure followed by 0 or more access_list data structures. The number of access_list data structures returned is specified in the acc1_count field of the access_info_1 data structure.

Restrictions

LAN Server and OS/2 Warp Server Only

This API can be called from DLS and OS/2 workstations, but DLS workstations can only issue this call to a remote LAN Server workstation. OS/2 workstations can issue this call locally only if the Peer service is started. User authority is allowed limited access to this API. Administrator authority is required for full access.

Directory and Security Server Only

A DSS server always returns NERR_InvalidAPI.

#include <netcons.h>
#include <access.h>
 
NetAccessGetInfo(pszServername, pszResource, sLevel, buf,
                 usBuflen, pusBytesAvail);     /* 16 bit */
 
Net32AccessGetInfo(pszServername, pszResource, ulLevel, buf,
                 ulBuflen, pulBytesAvail);     /* 32 bit */

See Common Parameter Definitions for descriptions of parameters not defined here.

sLevel or ulLevel

Resource Access Data Structures

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) кФФФФФФФФФФФФФФФФФФФФФФФФФФФФФТФФФФФФФТФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФПГSYMBOLICCONSTANT ГVALUEГMEANING Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_Success Г 0 Г No errors were encountered. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_ACCESS_DENIED Г 5 Г Administrator privilege is required. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_NOT_SUPPORTED Г 50 Г This request is not supported by the Г
Г Г Г network. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_BAD_NETPATH Г 53 Г The network path cannot be found. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_NETWORK_ACCESS_DENIED Г 65 Г Network access is denied. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_INVALID_PARAMETER Г 87 Г At least one parameter value is not Г
Г Г Г valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_INVALID_LEVEL Г 124 Г The sLevel parameter is not valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_MORE_DATA Г 234 Г Additional data is available, but the Г
Г Г Г buffer is too small. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_NetNotStarted Г 2102 Г The redirector NETWKSTA.200 has not Г
Г Г Г been started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_RemoteOnly Г 2106 Г This operation is not supported on Г
Г Г Г workstations. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_BufTooSmall Г 2123 Г The buffer is too small for fixed- Г
Г Г Г length data. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InternalError Г 2140 Г An internal error has occurred. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_BadTransactConfig Г 2141 Г The server is not configured for Г
Г Г Г transactions. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidAPI Г 2142 Г The requested API is not supported on Г
Г Г Г the remote server. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_ACFNotFound Г 2219 Г The NET.ACC file is missing. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_ResourceNotFound Г 2222 Г The netname cannot be found. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_ACFNotLoaded Г 2227 Г The UAS database has not been started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_ACFFileIOFail Г 2229 Г An error was encountered in accessing Г
Г Г Г the accounts database. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidDatabase Г 2247 Г The UAS database file is damaged. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidComputer Г 2351 Г The specified computer name is not Г
Г Г Г valid. Г
РФФФФФФФФФФФФФФФФФФФФФФФФФФФФФСФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

Other codes could be returned from the following functions:

DosAllocSeg
DosFsCtl
DosGetShrSeg
DosOpen

If you call this API with the buffer length parameter equal to zero, the API returns a value for total bytes available. This technique is useful if you do not know the exact buffer size required.

If the calling process does not have administrative privileges, NetAccessGetInfo can be called successfully only by a process that has special permissions (ACCESS_PERM) defined in the access permission record of the resource.

The specified pszResource must be a complete path name.

In specifying the pszQueueName for a resource, use the name originally assigned to the resource with the NetShareAdd API.

If sLevel is 1, NetAccessGetInfo returns an access_info_1 data structure followed by an access_list data structure for each entry in the list of the resource. The number of entries can be determined by examining the acc1_count component in the access_info_1 data structure.

If buf cannot hold all of the fixed-length and variable-length data (all access_list data structures), NetAccessGetInfo returns the NERR_BufTooSmall error code. Most GetInfo functions return the ERROR_MORE_DATA error code when more data is available.

You can determine the necessary buffer size by calling this API with usBuflen (or ulBuflen) set to 0. In this case, the API returns the number of bytes available in the pusBytesAvail (or pulBytesAvail) value. Then you can call this API again and allocate a buffer size (usBuflen or ulBuflen) at least as large as the returned bytes available.

For information about:

Listing all resources and permissions, see Access Permission - NetAccessEnum.
Changing the current permissions for a resource, see Access Permission - NetAccessSetInfo.

[Back]

[Next]