Interface nsIFileMetadataType

An interface that allows you to get some metadata like file size and file last modified time. These methods and attributes can throw NS_BASE_STREAM_WOULD_BLOCK in case the informations are not available yet. If this happens, consider the use of nsIAsyncFileMetadata.

If using nsIAsyncFileMetadata, you should retrieve any data via this interface before taking any action that might consume the underlying stream. For example, once Available(), Read(), or nsIAsyncInputStream::AsyncWait() are invoked, these methods may return NS_BASE_STREAM_CLOSED. This will happen when using RemoteLazyInputStream with an underlying file stream, for example.

Hierarchy

Properties

lastModified size

Methods

AddRef QueryInterface Release getFileDescriptor

Properties

Readonly lastModified

lastModified: number

File last modified time in milliseconds from midnight (00:00:00), January 1, 1970 Greenwich Mean Time (GMT).

Readonly size

size: number

File size in bytes.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

getFileDescriptor

  • The internal file descriptor. It can be used for memory mapping of the underlying file. Please use carefully! If this returns NS_BASE_STREAM_WOULD_BLOCK, consider the use of nsIAsyncFileMetadata.

    Returns PRFileDescPtr

Settings

Member Visibility

Theme

Generated using TypeDoc