listShares

Request

<listShares type=” “>
   <server/>
   <tree/>
   <startIdx/>
   <numEntries/>
</listShares>

Reply

<listShares>
   <shareInfo>
      <shareName/>
      <pathName/>
      <comment/>
   </shareInfo>
   <result value=" ">
      <description/>
   </result> 
</listShares>

Elements

listShares

Specifies what types of information to return for the shares.

server

(Optional) Specifies the distinguished name of the eDirectory server object. The name must be a fully distinguished name, including the leading dot before the object name and the trailing dot after the tree name (or with no leading or trailing dot but a complete identity of the object within the current tree). The default is the eDirectory object for the physical server.

tree

(Optional) Specifies the name of the eDirectory tree that contains the server. Defaults to the tree of the physical server.

startIdx

(Optional) Specifies the starting index of the first share to return. Defaults to 0 (start at the beginning).

numEntries

(Optional) Specifies the maximum number of shares to return. Defaults to return all shares.

shareInfo

Specifies the share information.

shareName

Specifies the share NetBios name that is advertised by CIFS. The share name is returned for both the basic and all type.

pathName

(Optional) Specifies the share path name. For example, sys:\system\. The path name is returned for only the all type.

comment

(Optional) Specifies a text string associated with the share. Comments are returned for only the all type.

result

Specifies a zError or eDirectory value or 0 (for no error).

description

Specifies a text description of the result.

Attributes

type

(Optional) Specifies what type of information to return:

• basic
• all

Defaults to basic information being returned.