StorageFile.IsEqual(IStorageItem) StorageFile.IsEqual(IStorageItem) StorageFile.IsEqual(IStorageItem) StorageFile.IsEqual(IStorageItem) StorageFile.IsEqual(IStorageItem) Method

Definition

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

public : Platform::Boolean IsEqual(IStorageItem item)
bool IsEqual(IStorageItem item) const;
public bool IsEqual(IStorageItem item)
Public Function IsEqual(item As IStorageItem) As bool
var bool = storageFile.isEqual(item);

Parameters

item
IStorageItem IStorageItem IStorageItem

The IStorageItem object that represents a file to compare against.

Returns

bool bool bool

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

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);
        }
    });
}

See also