SaveDataAreaPtr

Associates a data area pointer with a particular client NLM

Local Servers:nonblocking
Remote Servers:N/A
Classification:3.x, 4.x, 5.x, 6.x
Service:Library

Syntax

  #include <nwlib.h>  
   
  int SaveDataAreaPtr  (  
     LONG    libraryHandle,   
     void   *dataAreaPtr); 
  

Parameters

libraryHandle
(IN) Specifies the handle returned by calling RegisterLibrary.
dataAreaPtr
(IN) Points to a client NLM data area.

Return Values

The following table lists return values and descriptions.

Value

Hex

Name

Description

0

(0x00)

ESUCCESS

 

5

(0x5)

ENOMEM

Not enough memory.

Remarks

For a client NLM to be considered a client of a registered library by the NetWare API, the library must call SaveDataAreaPtr with a nonNULL data area pointer while the client is the current NLM (this is usually done when the client makes its first call to the library).

This function is normally used by library NLM applications to save a pointer to a data area the library allocates for each client. However, the dataAreaPtr parameter does not necessarily have to be a pointer, it can be an index into an array or anything else the library wants to associate with each client.

See Also

GetDataAreaPtr