IStorageItem2.IsEqual method

Applies to Windows only

Indicates whether the current item is the same as the specified item.

Syntax


bool IsEqual(
  IStorageItem item
)

Parameters

item

Type: IStorageItem

The IStorageItem object that represents a storage item to compare against.

Return value

Type: System.Boolean [.NET] | Platform::Boolean [C++]

Returns true if the current storage item is the same as the specified storage item; 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);
        }
    });
}


Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Minimum supported phone

None supported

Namespace

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

Metadata

Windows.winmd

See also

IStorageItem2
StorageFile.IsEqual
StorageFolder.IsEqual

 

 

Show:
© 2014 Microsoft