NWScanObject(3nw)


NWScanObject -- searches for bindery object name

Synopsis

   #include <nwbindry.h> 
   or 
   #include <nwcalls.h> 
   

NWCCODE N_API NWScanObject (NWCONN_HANDLE conn, pnstr8 searchName, nuint16 searchType, pnuint32 objID, pnstr8 objName, pnuint16 objType, pnuint8 hasPropertiesFlag, pnuint8 objFlags, pnuint8 objSecurity);

Description

The parameters are as follows:

conn
(IN) Specifies the NetWare server connection handle.

searchName
(IN) Points to the object name (with possible wildcards) for which to search.

searchType
(IN) Specifies the object type (can be wildcard) used in the search.

objID
(OUT) Points to the last object ID (optional). Should be set to 0xFF for the first search. -1 is assumed if no value is given. If -1 is used as the first search, a compiler warning will be returned.

objName
(OUT) Points to the name of the next matching object (optional).

objType
(OUT) Points to the type of the next matching object (optional).

hasPropertiesFlag
(OUT) Points to the properties flag (optional).

objFlags
(OUT) Points to the object flag byte (optional).

objSecurity
(OUT) Points to the security mask of the matching object (optional).

Return values

0x0000
SUCCESSFUL

0x8801
INVALID_CONNECTION

0x8996
SERVER_OUT_OF_MEMORY

0x89EF
INVALID_NAME

0x89FC
NO_SUCH_OBJECT

0x89FE
BINDERY_LOCKED

0x89FF
HARDWARE_FAILURE

Notices

NWScanObject iteratively scans the bindery for all objects matching both objName and objType. objID should be set to -1 for the first search. Upon return, objID receives a number to be used as the object identification for the next call.

hasPropertiesFlag can be one of the following:

0x00
matching object has no properties

0xFF
matching object has properties
objFlags can be one of the following:

BF_STATIC
matching object is static

BF_DYNAMIC
matching object is dynamic
The requesting process must be logged in to the NetWare server and have Read access to the bindery object.

objSecurity is a byte in which the low nibble controls Read security and the high nibble controls Write security. Read security determines which clients can find the bindery object when they scan for it. Write security defines which clients can create properties for the bindery object. The table below lists these security options:

Read Value Write Value Access Level Description
BS_ANY_READ BS_ANY_WRITE Anyone Access allowed to all clients, even if the client has not logged in to the server.
BS_LOGGED_READ BS_LOGGED_WRITE Logged Access allowed to all clients logged in to the server.
BS_OBJECT_READ BS_OBJECT_WRITE Object Access allowed only to clients who have logged in to the server with object's name, type, and password.
BS_SUPER_READ BS_SUPER_WRITE SUPERVISOR Access allowed only to clients who have logged in to the server as SUPERVISOR, or as a bindery object that is security-equivalent to SUPERVISOR.
BS_BINDERY_READ BS_BINDERY_WRITE NetWare Access allowed only to NetWare.

 
 --------------------------------------------------------------------- 
| Read Value     |  Write Value     |  Access Level|  Description    | 
|----------------|------------------|--------------|-----------------| 
| BS_ANY_READ    |  BS_ANY_WRITE    |  Anyone      |  Access allowed | 
|                |                  |              |  to all clients,| 
|                |                  |              |  even if the    | 
|                |                  |              |  client has not | 
|                |                  |              |  logged in to   | 
|                |                  |              |  the server.    | 
|----------------|------------------|--------------|-----------------| 
| BS_LOGGED_READ |  BS_LOGGED_WRITE |  Logged      |  Access allowed | 
|                |                  |              |  to all clients | 
|                |                  |              |  logged in to   | 
|                |                  |              |  the server.    | 
|----------------|------------------|--------------|-----------------| 
| BS_OBJECT_READ |  BS_OBJECT_WRITE |  Object      |  Access allowed | 
|                |                  |              |  only to clients| 
|                |                  |              |  who have logged| 
|                |                  |              |  in to the      | 
|                |                  |              |  server with    | 
|                |                  |              |  object's name, | 
|                |                  |              |  type, and      | 
|                |                  |              |  password.      | 
|----------------|------------------|--------------|-----------------| 
| BS_SUPER_READ  |  BS_SUPER_WRITE  |  SUPERVISOR  |  Access allowed | 
|                |                  |              |  only to clients| 
|                |                  |              |  who have logged| 
|                |                  |              |  in to the      | 
|                |                  |              |  server as      | 
|                |                  |              |  SUPERVISOR, or | 
|                |                  |              |  as a bindery   | 
|                |                  |              |  object that is | 
|                |                  |              |  security-      | 
|                |                  |              |  equivalent to  | 
|                |                  |              |  SUPERVISOR.    | 
|----------------|------------------|--------------|-----------------| 
| BS_BINDERY_READ|  BS_BINDERY_WRITE|  NetWare     |  Access allowed | 
|                |                  |              |  only to        | 
|                |                  |              |  NetWare.       | 
|----------------|------------------|--------------|-----------------| 
Values can be ORed together. For example, a bindery object with an objSecurity value of BS_SUPER_WRITE ORed with BS_LOGGED_READ (Hex 0x31) can be viewed by any client successfully logged in to the NetWare server, but only clients with SUPERVISOR security equivalence can add properties.

For items not desired in the return, NULL can be substituted. However, all parameter positions must be filled.

Services

Bindery

NCP calls

0x2222 23 55 Scan Bindery Object

 
 0x2222   23   55    Scan Bindery Object 

30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.