Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CachedFileManager class

Applies to Windows and Windows Phone

Lets apps manage real-time updates to files.

Syntax


public static class CachedFileManager

Attributes

[MarshalingBehavior(Agile)]
[Version(0x06020000)]

Members

The CachedFileManager class has these types of members:

Methods

The CachedFileManager class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
CompleteUpdatesAsync Initiates updates for the specified file.
DeferUpdates Lets apps defer real-time updates for a specified file.

 

Remarks

This class is static and cannot be instantiated. Call the methods directly instead.

Typically, Windows implicitly initiates updates for files that are provided by other apps when those files change.  However, you can control when updates are initiated by calling DeferUpdates. If you use this method are deferred until you call CompleteUpdatesAsync to initiate them.

Examples

The File picker sample shows you how to use a CachedFileManager to defer updates to a file until the app finishes modifying the file.


if (file != null)
{
    // Prevent updates to the remote version of the file until we finish making changes and call CompleteUpdatesAsync.
    CachedFileManager.DeferUpdates(file);

    // Write to file
    await FileIO.AppendTextAsync(file, "Swift as a shadow");
    // Let Windows know that we're finished changing the file so the server app can update the remote version of the file.

    // Complete updates. (May require Windows to ask for user input.)
    FileUpdateStatus status = await CachedFileManager.CompleteUpdatesAsync(file);
    switch (status)
    {
        case FileUpdateStatus.Complete:
            // Perform additional tasks like notifying user of status
            break;

        case FileUpdateStatus.CompleteAndRenamed:
            // Perform additional tasks like notifying user of status, or storing the renamed file for future use
            break;

        default:
            // Perform additional tasks like notifying user of status
            break;
    }
}


In the example, file is a local variable that contains a StorageFile that represents the file to defer updates for.

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Storage
Windows::Storage [C++]

Metadata

Windows.winmd

 

 

Show:
© 2014 Microsoft