Previous

Next

Function RTFGetFileInfo

This function is obsolete. Use RTFGetFileInfoEx instead.

RTFGetFileInfo returns information about an open file:

int RTFGetFileInfo(RTFHANDLE File, RTFFileInfo * FileInfo);

Parameters

File

References the open file for which information is requested.

FileInfo

Must point to a structure RTFFileInfo, declared in Rtfiles.h:

typedef struct { 
   const RTFDOSDirEntry * DirEntry; 
   DWORD                  FilePos; 
   DWORD                  AllocatedSize; 
   DWORD                  ClusterChains; 
   DWORD                  VolumeSerialNumber; 
   const char           * FullName; 
} RTFFileInfo;

return value

If the function succeeds, the return value is RTF_NO_ERROR. If the function fails, the return value is a negative error code.

This functions calls:

RTFGetFileInfoEx(File, .., RTF_FI_ALLOC_SIZE | RTF_FI_CLUSTER_CHAINS);

And copies the information for the RTFFileInfoEx structure to *FileInfo. If the file's size or allocated size is too large to fit in 32 bits, error code RTF_FILE_TOO_LARGE is returned. If the current file pointer is beyond 32 bits, RTF_LONG_FILE_POS is returned.

Obsolete Functions

Function RTFGetDiskInfo

Function RTFGetFileSize