StorageFile.IsEqual(IStorageItem) 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

Indicates whether the current file is equal to the specified file.

public:
 virtual bool IsEqual(IStorageItem ^ item) = IsEqual;

bool IsEqual(IStorageItem const& item);

public bool IsEqual(IStorageItem item);

function isEqual(item)

Public Function IsEqual (item As IStorageItem) As Boolean

Parameters

item: IStorageItem

The IStorageItem object that represents a file to compare against.

Returns

Boolean

bool

Returns true if the current file is equal to the specified file; otherwise false.

Implements

IsEqual(IStorageItem)

Remarks

Use the IsEqual method to determine whether two storage items represent the same file or folder.

This method compares the Path property of both items to determine if they are the same. If there is no Path (if the item is a library for example), or if the paths do not match the items are compared using IShellItem.Compare.

This example shows how to compare two storage files for equality.

function openNewFile() {
    var picker = new Windows.Storage.Pickers.FileOpenPicker;
    picker.fileTypeFilter.replaceAll(["*"]);
    picker.pickSingleFileAsync().then(function (file) {
        var alreadyOpenedFile = null;
        _openFiles.some(function (openFile) {
            if (file.IsEqual(openFile.file)) {
                alreadyOpenedFile = openFile;
                return true;
            }
            return false;
        });

        if (alreadyOpenedFile != null) {
            alreadyOpenedFile.window.activate();
        } else {
            createNewFileViewerWindow(file);
        }
    });
}

Applies to

Jaa