NWDSOpenStream(3nw)


NWDSOpenStream -- begins access to an attribute of type SYN_STREAM

Synopsis

   #include <nwnet.h> 
   or 
   #include <nwdsdsa.h> 
   

NWDSCCODE N_API NWDSOpenStream (NWDSContextHandle context, pnstr8 objectName, pnstr8 attrName, nflag32 flags, pnint fileHandle);

Description

The parameters are as follows:

context
(IN) Specifies the Directory context for the request.

objectName
(IN) Points to the name of the object having the attribute that is to be opened.

attrName
(IN) Points to the attribute name whose value is being read.

flags
(IN) Specifies the mode in which the stream is to be opened:

1 READ
2 WRITE
3 READ/WRITE

fileHandle
(OUT) Points to the file handle appropriate for the platform from which the API is being called.

Return values

0x0000
SUCCESSFUL

Negative Value
Negative values indicate errors. For errors returned by Directory Services, see ``Directory Services OS Errors'' (-001 to -255), ``Directory Services Client Library Errors'' (-301 to -399), or ``Directory Services Agent in the Server Errors'' (-601 to -699).

0x8996
SERVER_OUT_OF_MEMORY

0x89E2
TOO_FEW_FRAGMENTS

0x89E3
TOO_MANY_FRAGMENTS

0x89E4
PROTOCOL_VIOLATION

0x89E5
SIZE_LIMIT_EXCEEDED

0x89FD
UNKNOWN_REQUEST

0x89FD
INVALID_PACKET_LENGTH

0x89FE
BAD_PACKET

0x89FF
Failure not related to Directory Services

Notices

All attributes whose syntax is SYN_STREAM must be accessed by first calling NWDSOpenStream to retrieve a file handle to be used for accessing the attribute's value. The returned handle is a file handle that is appropriate for the platform on which the application is running. This file handle can be used to access the attribute value through the platform's standard file I/O functions.

Close the file handle by calling the platform's file close function.

You must use the file I/O functions that are appropriate for the platform on which the application is running. For DOS, call read, write, close, and seek. For Windows, call _lread, _lwrite, _lclose, and _llseek.

Attribute values that are of syntax SYN_STREAM are not accessed by NWDSGetAttrVal. When reading the attributes of an object that has a stream attribute (such as Login Script), NWDSGetAttrVal returns a zero-length octet string for the value of the stream attribute.


NOTE:

For NLM applications, if the handle returned by NWDSOpenStream is to be used by fdopen, NWDSOpenStream must be called with O_TEXT ORed in with the other values in flags.


Services

Directory

NCP calls

0x2222 23 17
Get File Server Information

0x2222 23 22
Get Station's Logged Info (old)

0x2222 23 28
Get Station's Logged Info

0x2222 104 01
Ping for NDS NCP

0x2222 104 02
Send NDS Fragmented Request/Reply

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