NWScanMountedVolumeList

Returns a list of mounted volumes

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

Syntax

   #include <nwvol.h> 
   or 
   #include <nwcalls.h> 
    
   NWCCODE  NWScanMountedVolumeList ( 
      nuint32                        conn,  
      nuint32                        volRequestFlags,  
      nuint32                        nameSpace,  
      pnuint32                       iterHandle,  
      nuint32                        numberItems,  
      pnuint32                       numberReturned,  
      NWVolMountNumWithName N_FAR   *volInfo); 
   
   

Pascal Syntax

   Function NWScanMountedVolumeList (
      conn : nuint32;
      volRequestFlags : nuint32;
      nameSpace : nuint32;
      VAR iterHandle : nuint32;
      numberItems : nuint32;
      VAR numberReturned : nuint32;
      volInfo : pNWVolMountNumWithName
   ) : NWCCODE;  stdcall;
   

Parameters

conn
(IN) Specifies the NetWare server connection handle.
volRequestFlags
(IN) Specifies only the volume number or the volume number with the volume name.
nameSpace
(IN) Specifies the name space for which you want to get the mounted volume list.
iterHandle
(IN/OUT) Points to an nuint32 containing the number of the next record to be scanned. (Set to 0 for the first call.)
numberItems
(IN) Specifies the size of the array passed into volMountedArr.
numberReturned
(OUT) Specifies how many volumes are actually in the array pointed to by volMountedArr.
volMountArr
(OUT) Points to an array of NWVolMountNumWithName structures containg a list of volumes returned from the current call.

Return Values

These are common return values; see Return Values (Return Values for C) for more information.

0x0000

SUCCESSFUL

0x8801

INVALID_CONNECTION

0x8836

INVALID_PARAMETER

Remarks

NWScanMountedVolumeList allows you to pass in a pointer to a variably sized array of NWVolMountNumWithName structures. On return, that pointer points to a list of mounted vloumes. Based on the size of the array and number of mounted volumes, NWScanMountedVolumeList might return the complete list in only one call or might take multiple calls.

To call NWScanMountedVolumeList iteratively, pass in zero for the iterHandle parameter on the first call. On return, check iterHandle to get the number of the next record to scan for mounted volumes. When iterHandle contains zero on return, there are no more records to scan.

The volRequestFlags parameter can take one of the following values:

NW_VOLUME_NUMBER_ONLY

0

NW_VOLUME_NUMBER_AND_NAME

1

The nameSpace parameter can use any of the constant values identified in Naming Conventions (Multiple and Inter-File Services).

NWScanMountedVolumeList is implented through a call to NCP 0x2222 22 52. This NCP is supported on NetWare 4.x and above.

NCP Calls