getFileInfo

Returns the information (properties of a file).

Request

<fileInfo>
   <getEffectiveRightsByUser>
      <context/>
      <name/>
      <filename/>
      <nameSpace/>
      <nameType/>
   </getEffectiveRightsByUser>
   <getFileInfo>
      <fileName/>
      <typeOfInfo>
         <rightsInfo/>
         <standardInfo/>
         <timeInfo/>
         <idInfo/>
         <nfsInfo/>
         <visibilityInfo/>
         <symlink/>
         <directoryQuotaInfo>
            <quotaAmount/>
            <usedAmount/>
         </directoryQuotaInfo>
      </typeOfInfo>
   </getFileInfo>
</fileInfo>

Reply

<fileInfo>
   <getEffectiveRightsByUser>
      <effectiveRights>
         <read/>
         <write/>
         <create/>
         <erase/>
         <accessControl/>
         <fileScan/>
         <modify/>
         <visibility/>
         <supervisor/>
      </effectiveRights>
   </getEffectiveRightsByUser>
   <getFileInfo>
      <rightsInfo>
         <trusteeList>
            <trusteeInfo>
               <trustee>
                  <rights>
                     <supervisor/>
                     <read/>
                     <write/>
                     <create/>
                     <erase/>
                     <modify/>
                     <fileScan/>
                     <accessControl/>
                     <salvage/>
                     <secure/>
                  </rights>
               </trustee>
            </trusteeInfo>
         </trusteeList>
         <inheritedRightsFilter>
            <supervisor/>
            <read/>
            <write/>
            <create/>
            <erase/>
            <modify/>
            <fileScan/>
            <accessControl/>
            <salvage/>
            <secure/>
         </inheritedRightsFilter>
         <effectiveRights>
           <read/>
           <write/>
           <create/>
           <erase/>
           <accessControl/>
           <fileScan/>
           <modify/>
           <supervisor/>
      </effectiveRights>
         <result value=" ">
            <description/>
         </result>
      </rightsInfo>
      <standardInfo>
         <volumeName/>
         <id/>
         <parentID/>
         <logicalEOF/>
         <physicalEOF/>
         <attributes>
            <readOnly/>
            <hidden/>
            <system/>
            <subdirectory/>
            <archive/> 
            <shareable/>
            <noSuballoc/>
            <transaction/>
            <notVirtual/>
            <immediatePurge/>
            <renameInhibit/>
            <deleteInhibit/>
            <copyInhibit/>
            <adminLink/>
            <link/>
            <remoteDataAccess/>
            <remoteDataInhibit/>
            <compressImmediate/>
            <dataStreamCompress/>
            <doNotCompress/>
            <noStreamCompress/>
            <attrArchive/>
            <volatile/>
         </attributes>
      </standardInfo>
      <timeInfo>
         <createdTime>
            <utc/>
            <string/>
         </createdTime>
         <archivedTime>
            <utc/>
            <string/>
         </archivedTime>
         <modifiedTime>
            <utc/>
            <string/>
         </modifiedTime>
         <accessedTime>
            <utc/>
            <string/>
         </accessedTime>
         <metaDataModifiedTime>
            <utc/>
            <string/>
         </metaDataModifiedTime>
      </timeInfo>
      <idInfo>
         <creator/>
         <archiver/>
         <modifier/>
         <metaDataModifier/>
      </idInfo>
      <nfsInfo>
          <nfsName/>
          <mode/>
          <symLink/>
          <user>
             <id/>
             <name/>
          </user>
          <group>
              <id/>
              <name/>
           </group>
           <rights/>
      </nfsInfo>
      <visibilityInfo>
         <visibilityEntry>
            <name/>
            <id/>
         </visibilityEntry>
      </visibilityInfo>
      <directoryQuotaInfo>
         <quotaAmount/>
         <usedAmount/>
      </directoryQuotaInfo>     
         <result value=" ">
            <description/>
         </result>
      </getFileInfo>
   </fileInfo>
   <result value=" ">
      <description/>
   </result>
</fileReply>

Elements

context: Specifies the context of the user. For example, novell.server.tree. You can omit the context and specify a fully qualified name instead.
name: Specifies the name of the user. For example, admin.
fileName: Specifies the file name to retrieve the information for.
nameSpace: Specifies the name space of the file. nameSpace is an optional tag and is required only when the file name is specified as NSS path.
nameType: Specifies the type of the file name such as File, DataStream, ExtendedAttribute and DeletedFile.
typeOfInfo: Specifies the category of information to return.
rightsInfo: Specifies the trustee rights information.
standardInfo: Specifies the general information about the file (EOF, ID, attributes, etc.).
timeInfo: Specifies the creation, modification, archival, and access time.
directoryQuotaInfo: Specifies the directory quota information.
quotaAmount: Specifies the amount of the quota (in bytes). If there is no quota, quotaAmount is -1 and usedAmount is 0.
usedAmount: Specifies the number of bytes that are used in the current directory and its children. If -1 is specified, the quota is removed.
effectiveRights: Specifies the rights for the user that is making the request.
trusteeInfo: Repeats for each assigned trustee.
trustee: Specifies the right-rooted, dot-delimited trustee name.
rights: Specifies the assigned rights for the trustee.
inheritedRightsFilter: Specifies the rights in the current filter.
standardInfo: Specifies the generic information for the file.
volumeName: Specifies the name of the logical volume that contains the file.
id: Specifies the unique ID for a file on a volume.
(Optional) symLink: Specifies not to follow the link.
parentID: Specified the ID of the primary parent.
logicalEOF: Specifies the location of the end of useful data in the file.
physicalEOF: Specifies the number of allocated bytes for the file (unless it is sparse).
timeInfo: Specifies various time stamps for the file.
utc: Specifies a number representing the UTC time.
string: Specifies the date, in string format.
idInfo: Specifies the IDs of various users.
creator: Specifies the right-rooted, dot-delimited directory name of the file's creator.
archiver: Specifies the right-rooted, dot-delimited directory name of the person who last archived the file.
modifier: Specifies the right-rooted, dot-delimited directory name of the person who last modified the file.
metaDataModifier: Specifies the right-rooted, dot-delimited directory name.
result: Specifies an error value or 0 (for no error).
description: Specifies a text description of the result.

Example

<virtualIO>
   <datastream name="command"/>
</virtualIO>

<fileRequest>
   <fileInfo>
      <getFileInfo>
      <fileName>test:\testdir</fileName>
      <nameSpace>unix</nameSpace>
         <typeOfInfo>
            <rightsInfo/>
            <standardInfo/>
            <timeInfo/>
            <idInfo/>
            <directoryQuotaInfo>
               <quotaAmount/>
               <usedAmount/>
           </directoryQuotaInfo>
        </typeOfInfo>
     </getFileInfo>
   </fileInfo>
</fileRequest>