NetAccessCheck or Net32AccessCheck

The NetAccessCheck API verifies that a user has the proper access permission for a particular resource.

Restrictions

LAN Server and OS/2 Warp Server Only

This API can be called from OS/2 servers. OS/2 workstations can issue this call locally only if the Peer service is started.

Directory and Security Server Only

This API returns an ERROR_ACCESS_DENIED if the user is not logged on.

A redirected drive should not be specified for pszResource. If a redirected drive is specified, a NERR_ResourceNotFound error code is returned.

Syntax

#include <netcons.h>
#include <access.h>
 
NetAccessCheck(reserved, pszUserID, pszResource,
                 AccessPermission, pResult);     /* 16 bit */
 
Net32AccessCheck(reserved, pszUserID, pszResource,
                 AccessPermission, pResult);     /* 32 bit */

Parameters

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

reserved

(unsigned char LSFAR *) must be NULL.
AccessPermission
(16-bit unsigned short or 32-bit unsigned long) specifies which access permission the API is to verify for this user on this resource. Defined in the ACCESS.H header file, any combination of the following values can be used: ┌──────────────────────┬───────┬───────────────────────────────────────────────┐
│ SYMBOLIC CONSTANT │ VALUE │ MEANING │
├──────────────────────┼───────┼───────────────────────────────────────────────┤
│ ACCESS_READ │ 0x01 │ Permission to read data from a resource and, │
│ │ │ by default, run the resource. │
├──────────────────────┼───────┼───────────────────────────────────────────────┤
│ ACCESS_WRITE │ 0x02 │ Permission to write data to the resource. │
├──────────────────────┼───────┼───────────────────────────────────────────────┤
│ ACCESS_CREATE │ 0x04 │ Permission to create an instance of the │
│ │ │ resource (such as a file) data can be written │
│ │ │ to the resource when the resource is being │
│ │ │ created. │
├──────────────────────┼───────┼───────────────────────────────────────────────┤
│ ACCESS_EXEC │ 0x08 │ Permission to run the resource. │
├──────────────────────┼───────┼───────────────────────────────────────────────┤
│ ACCESS_DELETE │ 0x10 │ Permission to delete the resource. │
├──────────────────────┼───────┼───────────────────────────────────────────────┤
│ ACCESS_ATRIB │ 0x20 │ Permission to modify the attributes of a │
│ │ │ resource (such as the date and time a file │
│ │ │ was last modified). │
├──────────────────────┼───────┼───────────────────────────────────────────────┤
│ ACCESS_PERM │ 0x40 │ Permission to modify the permissions (read, │
│ │ │ write, create, execute, and delete) assigned │
│ │ │ to a resource for a user or application. │
├──────────────────────┼───────┼───────────────────────────────────────────────┤
│ ACCESS_ALL │ 0x7F │ Permission to read, write, create, execute, │
│ │ │ or delete a resource, or to modify attributes │
│ │ │ or permissions. │
└──────────────────────┴───────┴───────────────────────────────────────────────┘

pResult
(16-bit unsigned short LSFAR * or 32-bit unsigned long LSFAR *) points to an unsigned short integer specifying whether the requested access is permitted. Access is permitted only if pResult points to 0, and the return code from the API is 0 (NERR_Success).
Return Codes

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_INVALID_PARAMETER │ 87 │ At least one parameter value is not valid. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ NERR_ServerNotStarted │ 2114 │ The Server service has not been started. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ NERR_InternalError │ 2140 │ An internal error has occurred. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ NERR_InvalidAPI │ 2142 │ The requested API is not supported on the │
│ │ │ remote server. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ NERR_ACFNotFound │ 2219 │ The NET.ACC file is missing. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ NERR_UserNotFound │ 2221 │ The user name cannot be found. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ 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. │
└─────────────────────────┴───────┴────────────────────────────────────────────┘


Other codes could be returned from the following functions:

• DosAllocSeg
  
• DosChgFilePtr
  
• DosFsCtl
  
• DosOpen
  
• DosRead
Remarks

If an access permission record cannot be found for the specified user name and the specified resource, the NetAccessCheck API tries to find the proper access permission record for the GUEST account, a special account set up for temporary users of the resource. GUEST accounts are defined in the IBMLAN.INI file.

Related Information

For information about:

• Defining user or group access permissions, see Access Permission - NetAccessAdd.

• GUEST accounts, see the LAN Server Network Administrator Reference Volume 3: Network Administrator Tasks.

• Listing all permissions and resources, see Access Permission - NetAccessEnum.

---

[Back: NetAccessApply or Net32AccessApply]
[Next: NetAccessDel or Net32AccessDel]