NWReadPropertyValue

Reads the property value of a bindery object

Local Servers:blocking
Remote Servers:blocking
NetWare Server:3.11, 3.12, 4.x, 5.x, 6.x
Platform:NLM, Windows NT, Windows 95, Windows 98
Library:Cross-Platform NetWare Calls (CAL*.*)
Service:Bindery

Syntax

C

   #include <nwbindry.h> 
   or 
   #include <nwcalls.h> 
    
   NWCCODE N_API  NWReadPropertyValue  ( 
      NWCONN_HANDLE       conn,  
      const nstr8 N_FAR  *objName,  
      nuint16             objType,  
      const nstr8 N_FAR  *propertyName,  
      nuint8              segmentNum,  
      pnuint8             segmentData,  
      pnuint8             moreSegments,  
      pnuint8             flags);

Pascal

   uses calwin32 
    
   Function NWReadPropertyValue 
     (conn : NWCONN_HANDLE; 
      const objName : pnstr8; 
      objType : nuint16; 
      const propertyName : pnstr8; 
      segmentNum : nuint8; 
      segmentData : pnuint8; 
      moreSegments : pnuint8; 
      flags : pnuint8 
   ) : NWCCODE; stdcall;

Parameters

conn
(IN) Specifies the NetWare server connection handle.
objName
(IN) Points to the object name containing the property.
objType
(IN) Specifies the type of the object containing the property.
propertyName
(IN) Points to the name of the property whose information is being retrieved.
segmentNum
(IN) Specifies the segment number of the data (128-byte blocks) to be read (set to 1 initially).
segmentData
(OUT) Points to the 128-byte buffer receiving the property data.
moreSegments
(OUT) Points to a flag indicating if there are more segments to be returned:
  • 0x00 No more segments to be read
  • 0xFF More segments to be read
flags
(OUT) Points to the property type (optional):
  • BF_ITEM
  • BF_SET

Return Values

These are common return values. See Return Values (Return Values for C).

0x0000

SUCCESSFUL

0x8801

INVALID_CONNECTION

0x890A

NLM_INVALID_CONNECTION

0x8988

INVALID_FILE_HANDLE

0x8993

NO_READ_PRIVILEGES

0x8996

SERVER_OUT_OF_MEMORY

0x89EC

NO_SUCH_SEGMENT

0x89F0

WILD_CARD_NOT_ALLOWED

0x89F1

INVALID_BINDERY_SECURITY

0x89F9

NO_PROPERTY_READ_PRIVILEGES

0x89FB

N0_SUCH_PROPERTY

0x89FC

NO_SUCH_OBJECT

0x89FE

BINDERY_LOCKED

0x89FF

HARDWARE_FAILURE

Remarks

Read access to the property is required to successfully call NWReadPropertyValue.

On the first call to NWReadPropertyValue set the segmentNum parameter to 1. For each subsequet call, increment segmentNum until the moreSegments parameter is set to 0 or until NWReadPropertyValue returns NO_SUCH_SEGMENT.

The objName, objType, and propertyName parameters must uniquely identify the property and cannot contain wildcard characters.

If the property is of type SET, the data returned in the segmentData parameter is an array of bindery object IDs. The bindery attaches no significance to the contents of a property value if the property is of type ITEM.

See Object Type.

See Activity Coordination.

See binscan.c for sample code.

NCP Calls

See Also

NWWritePropertyValue