StorageFile.GetBasicPropertiesAsync Method

Reference

Definition

Namespace:: Windows.Storage

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Gets the basic properties of the current file.

public:
 virtual IAsyncOperation<BasicProperties ^> ^ GetBasicPropertiesAsync() = GetBasicPropertiesAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<BasicProperties> GetBasicPropertiesAsync();

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<BasicProperties> GetBasicPropertiesAsync();

function getBasicPropertiesAsync()

Public Function GetBasicPropertiesAsync () As IAsyncOperation(Of BasicProperties)

Returns

IAsyncOperation<BasicProperties>

When this method completes successfully, it returns the basic properties of the current file as a BasicProperties object.

Implements

GetBasicPropertiesAsync()

Attributes: RemoteAsyncAttribute

Examples

This example shows you how to access basic properties of a file using the storageFile.getBasicPropertiesAsync method.

storageFile.getBasicPropertiesAsync().then(
    function (basicProperties) {
        var size  = basicProperties.size;
    }
);

You must have a StorageFile object (storageFile in the example) that represents your file in order to use the storageFile.getBasicPropertiesAsync method.

Remarks

This method will return E_ILLEGAL_METHOD_CALL if there are other async operations in progress on the same StorageItem instance. Make sure that another thread isn't modifying the StorageItem at the same time.

Applies to

Jaa