NWScanProperty(3nw)


NWScanProperty -- scans bindery object for properties matching property name

Synopsis

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

NWCCODE N_API NWScanProperty (NWCONN_HANDLE conn, pnstr8 objName, nuint16 objType, pnstr8 searchPropertyName, pnuint32 iterHandle, pnstr8 propertyName, pnuint8 propertyFlags, pnuint8 propertySecurity, pnuint8 valueAvailable, pnuint8 moreFlag);

Description

The parameters are as follows:

conn
(IN) Specifies the NetWare server connection handle.

objName
(IN) Points to the set's object name.

objType
(IN) Specifies the set's bindery object type.

searchPropertyName
(IN) Points to the property name (with possible wildcards) for which to search.

iterHandle
(OUT) Points to the iteration handle to use when making repeated calls (optional). Should be set to -1 for first call. If not used, -1 is assumed.

propertyName
(OUT) Points to the name of the next matching property (optional). Can be up to 15 characters including the NULL terminator.

propertyFlags
(OUT) Points to the status flag (optional): BF_STATIC or BF_DYNAMIC.

propertySecurity
(OUT) Points to the security mask (optional).

valueAvailable
(OUT) Points to a flag indicating whether the property has value (optional).

moreFlag
(OUT) Points to the more properties flag (optional).

Return values

0x0000
SUCCESSFUL

0x8801
INVALID_CONNECTION

0x8996
SERVER_OUT_OF_MEMORY

0x89F0
WILD_CARD_NOT_ALLOWED

0x89FB
NO_SUCH_PROPERTY

0x89FC
NO_SUCH_OBJECT

0x89FE
BINDERY_LOCKED

0x89FF
HARDWARE_FAILURE

Notices

Optional iterHandle should be assigned -1 for the first scan. When NWScanProperty returns, moreFlag contains 0xFF if the matched property is not the last property, and iterHandle receives the number to use in the next call.

NWScanProperty requires Read access to the bindery object as well as the property.

objName and objType must uniquely identify the bindery object and cannot contain wildcard characters.

propertyFlags determines the property's type and whether it is static or dynamic.

valueAvailable can be either of the following:

0x00
property has no value

0xFF
property has value
moreFlag can be one of the following:

0x00
no more properties for object

0xFF
more properties exist
propertySecurity is a byte in which the low nibble controls Read security and the high nibble controls Write security. The following table summarizes the security values.

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.       | 
|----------------|------------------|--------------|-----------------| 
For items not desired in the return, NULL can be substituted; however, all parameter positions must be filled.

Values can be ORed together. For example, BS_SUPER_WRITE ORed with BS_LOGGED_READ (Hex 0x31) indicates any user logged in to the NetWare server can view the property, but only the SUPERVISOR can write to the property.

Services

Bindery

NCP calls

0x2222 23 60 Scan Property

 
 0x2222   23   60   Scan Property 

References

NWReadPropertyValue(3nw), NWWritePropertyValue(3nw)
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.