Syntax

  #include <\nlm\nit\nwextatt.h>  
   
  int EnumerateEA (  
     int          handle,  
     const char  *keyBuffer,  
     char        *dataBuffer,  
     LONG         dataBufferSize,  
     int          startPosition,  
     LONG        *dataSize,  
     LONG        *EAsInReply);
  

Parameters

handle

(IN) Specifies the handle of the file or directory whose EAs are to be enumerated.

keyBuffer

(IN) Specifies the key of an EA defined in the file or directory or else NULL to retrieve all EA information (maximum size is 255 bytes).

dataBuffer

(OUT) Receives the requested information. Either a single instance of the T_enumerateEAwithKey structure if a key was specified or multiple instances (one for every EA) of T_enumerateEAnoKey.

dataBufferSize

(IN) Specifies the size of dataBuffer. Only as much information as can fit is returned (there must be room to return information for at least one EA). If there is not enough room for at least one EA, EAsInReply is 0.

startPosition

(IN) If no key is specified, the starting position identifies the EA for which to start returning information. Normally, the starting position is 0.

dataSize

(OUT) Returns the number of bytes of information returned in dataBuffer.

EAsInReply

(OUT) Returns the number of EAs for which information was returned.

Return Values

This function returns a value of 0 if successful. Otherwise, it returns an error code (nonzero value).

Remarks

This function is used to determine which EAs are defined for a particular file or directory or how big an EA or set of EAs is.

If a key value is specified for keyBuffer, only information about that key is returned in dataBuffer.

If NULL or an empty key is specified, information about all the keys is returned in dataBuffer.

This function does not work for remote NetWare 3.x servers.

See Also

GetEAInfo, ReadEA, WriteEA