FolderInformation FolderInformation FolderInformation FolderInformation Class

Provides synchronous access to the properties exposed off StorageFolder and lets an app perform asynchronous management operations such as copy, delete, move, and rename.

Syntax

Declaration

public sealed class FolderInformationpublic sealed class FolderInformationPublic NotInheritable Class FolderInformation

Remarks

Note

Although it's not attributed with marshalling_behavior(agile), this class can be treated as agile. For more info, see Threading and Marshaling (C++/CX).

You can retrieve a list of FolderInformation objects by calling one of the GetFoldersAsync(System.UInt32,System.UInt32) methods.

Properties summary

Gets the attributes of a loaded folder.

Gets an object that contains the basic properties information of the folder.

Gets the date that the folder was created.

Gets the user-friendly name of the StorageFolder.

Gets the display type of the StorageFolder.

Gets the document properties of the StorageFolder.

Gets the identifier that uniquely identifies the StorageFolder relative to other items in the same folder.

Gets the image properties of the StorageFolder.

Gets the music properties associated with the StorageFolder.

Gets the name of the StorageFolder.

Gets the path of the StorageFolder.

Gets an object for retrieving the properties of the StorageFolder.

Gets the StorageProvider object that contains info about the service that stores the current folder.

Gets the thumbnail for the StorageFile.

Gets the video properties that are associated with the StorageFolder.

Methods summary

Retrieves a value that indicates whether the folder supports the specified search query options.

Creates a new file in the current folder.

Creates a new file in the current folder, and specifies what to do if a file with the same name already exists in the current folder.

Creates an object for performing filtered search queries for StorageFile in the current folder.

Creates an object for performing filtered search queries for StorageFile objects in the current folder. Search results are grouped based on the specified file attribute.

Creates an object used to perform filtered search queries for StorageFile objects in the folder. The object is initialized with the specified query options.

Creates a new child folder of the current folder.

Creates a new child folder of the current folder, and specifies what to do if a folder with the same name already exists in the current folder.

Creates an object for performing filtered search queries for child StorageFolder objects of the current folder.

Creates an object for performing filtered search queries for child StorageFolder objects of the current folder. Search results are grouped based on the specified folder attribute.

Creates an object used to perform filtered search queries for child StorageFolder objects of the current folder. The object is initialized with the specified query options.

Creates an object used to perform filtered search queries for items in the folder.

Creates an object used to perform filtered search queries for items in the folder. The object is initialized with the specified query options.

Deletes the current folder.

Deletes the current folder, optionally moving the deleted folder to the recycle bin.

Retrieves the basic properties of the StorageFolder object.

Retrieves a file from the current folder.

Retrieves all files from the current folder.

Retrieves files from the current folder based on a common folder query.

Retrieves a range of files from the current folder based on a common file query.

Retrieves the specified child folder from the current folder.

Retrieves all child folders from the current folder.

Retrieves child folders from the current folder based on a common folder query.

Retrieves a range of child folders from the current folder based on a common folder query.

Retrieves the indexed state of the folder.

Retrieves an item from the folder.

Retrieves all items from the current folder.

Retrieves a range of items from the current folder.

Gets the parent folder of the current folder.

Retrieves the thumbnail that is associated with the StorageFolder.

Retrieves the thumbnail that is associated with the StorageFolder, scaling it to the specified size.

Retrieves the thumbnail that is associated with the StorageFolder, based on the specified options.

Retrieves a value that indicates whether the current folder supports the specified common file query.

Retrieves a value that indicates whether the current folder supports the specified common folder query.

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

Determines whether the loaded StorageFolder is the specified type.

Renames the StorageFolder.

Renames the StorageFolder, and specifies what to do if a folder with the same name already exists.

Try to get a specific file or sub-folder from the current folder using the name of the file or folder to get.

Events summary

Occurs when one or more of the StorageFolder 's properties is updated.

Fires when the StorageFolder 's thumbnail is updated or a better quality thumbnail is available.

Properties

  • Attributes
    Attributes
    Attributes
    Attributes

    Gets the attributes of a loaded folder.

    public FileAttributes Attributes { get; }public FileAttributes Attributes { get; }Public ReadOnly Property Attributes As FileAttributes

    Property Value

  • BasicProperties
    BasicProperties
    BasicProperties
    BasicProperties

    Gets an object that contains the basic properties information of the folder.

    public BasicProperties BasicProperties { get; }public BasicProperties BasicProperties { get; }Public ReadOnly Property BasicProperties As BasicProperties

    Property Value

  • DateCreated
    DateCreated
    DateCreated
    DateCreated

    Gets the date that the folder was created.

    public DateTime DateCreated { get; }public DateTime DateCreated { get; }Public ReadOnly Property DateCreated As DateTime

    Property Value

    Remarks

    If the date property isn't set, this value defaults to 0 which can be translated into misleading dates in different programming languages. In JavaScript, for example, 0 translates to December 16, 1600. You should always check that this property is a real value and not 0.

  • DisplayName
    DisplayName
    DisplayName
    DisplayName

    Gets the user-friendly name of the StorageFolder.

    public string DisplayName { get; }public string DisplayName { get; }Public ReadOnly Property DisplayName As string

    Property Value

    • string
      string
      string
      string

      The user-friendly name of the StorageFolder.

  • DisplayType
    DisplayType
    DisplayType
    DisplayType

    Gets the display type of the StorageFolder.

    public string DisplayType { get; }public string DisplayType { get; }Public ReadOnly Property DisplayType As string

    Property Value

    • string
      string
      string
      string

      The display type.

  • DocumentProperties
    DocumentProperties
    DocumentProperties
    DocumentProperties

    Gets the document properties of the StorageFolder.

    public DocumentProperties DocumentProperties { get; }public DocumentProperties DocumentProperties { get; }Public ReadOnly Property DocumentProperties As DocumentProperties

    Property Value

  • FolderRelativeId
    FolderRelativeId
    FolderRelativeId
    FolderRelativeId

    Gets the identifier that uniquely identifies the StorageFolder relative to other items in the same folder.

    public string FolderRelativeId { get; }public string FolderRelativeId { get; }Public ReadOnly Property FolderRelativeId As string

    Property Value

    • string
      string
      string
      string

      The folder-relative identifier.

  • ImageProperties
    ImageProperties
    ImageProperties
    ImageProperties

    Gets the image properties of the StorageFolder.

    public ImageProperties ImageProperties { get; }public ImageProperties ImageProperties { get; }Public ReadOnly Property ImageProperties As ImageProperties

    Property Value

  • MusicProperties
    MusicProperties
    MusicProperties
    MusicProperties

    Gets the music properties associated with the StorageFolder.

    public MusicProperties MusicProperties { get; }public MusicProperties MusicProperties { get; }Public ReadOnly Property MusicProperties As MusicProperties

    Property Value

  • Name
    Name
    Name
    Name

    Gets the name of the StorageFolder.

    public string Name { get; }public string Name { get; }Public ReadOnly Property Name As string

    Property Value

  • Path
    Path
    Path
    Path

    Gets the path of the StorageFolder.

    public string Path { get; }public string Path { get; }Public ReadOnly Property Path As string

    Property Value

    • string
      string
      string
      string

      The path.

  • Properties
    Properties
    Properties
    Properties

    Gets an object for retrieving the properties of the StorageFolder.

    public StorageItemContentProperties Properties { get; }public StorageItemContentProperties Properties { get; }Public ReadOnly Property Properties As StorageItemContentProperties

    Property Value

  • Provider
    Provider
    Provider
    Provider

    Gets the StorageProvider object that contains info about the service that stores the current folder.

    public StorageProvider Provider { get; }public StorageProvider Provider { get; }Public ReadOnly Property Provider As StorageProvider

    Property Value

  • Thumbnail
    Thumbnail
    Thumbnail
    Thumbnail

    Gets the thumbnail for the StorageFile.

    public StorageItemThumbnail Thumbnail { get; }public StorageItemThumbnail Thumbnail { get; }Public ReadOnly Property Thumbnail As StorageItemThumbnail

    Property Value

  • VideoProperties
    VideoProperties
    VideoProperties
    VideoProperties

    Gets the video properties that are associated with the StorageFolder.

    public VideoProperties VideoProperties { get; }public VideoProperties VideoProperties { get; }Public ReadOnly Property VideoProperties As VideoProperties

    Property Value

Methods

  • AreQueryOptionsSupported(Windows.Storage.Search.QueryOptions)
    AreQueryOptionsSupported(Windows.Storage.Search.QueryOptions)
    AreQueryOptionsSupported(Windows.Storage.Search.QueryOptions)
    AreQueryOptionsSupported(Windows.Storage.Search.QueryOptions)

    Retrieves a value that indicates whether the folder supports the specified search query options.

    public bool AreQueryOptionsSupported(Windows.Storage.Search.QueryOptions queryOptions)public bool AreQueryOptionsSupported(Windows.Storage.Search.QueryOptions queryOptions)Public Function AreQueryOptionsSupported(queryOptions As Windows.Storage.Search.QueryOptions) As bool

    Parameters

    Returns

    • bool
      bool
      bool
      bool

      True if the folder supports the specified search query options; otherwise false.

  • CreateFileAsync(System.String)
    CreateFileAsync(System.String)
    CreateFileAsync(System.String)
    CreateFileAsync(System.String)

    Creates a new file in the current folder.

    public IAsyncOperation<StorageFile> CreateFileAsync(System.String desiredName)public IAsyncOperation<StorageFile> CreateFileAsync(System.String desiredName)Public Function CreateFileAsync(desiredName As System.String) As IAsyncOperation( Of StorageFile )

    Parameters

    • desiredName
      System.String
      System.String
      System.String
      System.String

      The name of the new file.

    Returns

    • When this method completes successfully, it returns a StorageFile that represents the new file.

  • CreateFileAsync(System.String,Windows.Storage.CreationCollisionOption)
    CreateFileAsync(System.String,Windows.Storage.CreationCollisionOption)
    CreateFileAsync(System.String,Windows.Storage.CreationCollisionOption)
    CreateFileAsync(System.String,Windows.Storage.CreationCollisionOption)

    Creates a new file in the current folder, and specifies what to do if a file with the same name already exists in the current folder.

    public IAsyncOperation<StorageFile> CreateFileAsync(System.String desiredName,Windows.Storage.CreationCollisionOption options)public IAsyncOperation<StorageFile> CreateFileAsync(System.String desiredName,Windows.Storage.CreationCollisionOption options)Public Function CreateFileAsync(desiredName As System.String,options As Windows.Storage.CreationCollisionOption) As IAsyncOperation( Of StorageFile )

    Parameters

    Returns

    • When this method completes successfully, it returns a StorageFile that represents the new file.

  • CreateFileQuery()
    CreateFileQuery()
    CreateFileQuery()
    CreateFileQuery()

    Creates an object for performing filtered search queries for StorageFile in the current folder.

    public StorageFileQueryResult CreateFileQuery()public StorageFileQueryResult CreateFileQuery()Public Function CreateFileQuery() As StorageFileQueryResult

    Returns

  • CreateFileQuery(Windows.Storage.Search.CommonFileQuery)
    CreateFileQuery(Windows.Storage.Search.CommonFileQuery)
    CreateFileQuery(Windows.Storage.Search.CommonFileQuery)
    CreateFileQuery(Windows.Storage.Search.CommonFileQuery)

    Creates an object for performing filtered search queries for StorageFile objects in the current folder. Search results are grouped based on the specified file attribute.

    public StorageFileQueryResult CreateFileQuery(Windows.Storage.Search.CommonFileQuery query)public StorageFileQueryResult CreateFileQuery(Windows.Storage.Search.CommonFileQuery query)Public Function CreateFileQuery(query As Windows.Storage.Search.CommonFileQuery) As StorageFileQueryResult

    Parameters

    Returns

  • CreateFileQueryWithOptions(Windows.Storage.Search.QueryOptions)
    CreateFileQueryWithOptions(Windows.Storage.Search.QueryOptions)
    CreateFileQueryWithOptions(Windows.Storage.Search.QueryOptions)
    CreateFileQueryWithOptions(Windows.Storage.Search.QueryOptions)

    Creates an object used to perform filtered search queries for StorageFile objects in the folder. The object is initialized with the specified query options.

    public StorageFileQueryResult CreateFileQueryWithOptions(Windows.Storage.Search.QueryOptions queryOptions)public StorageFileQueryResult CreateFileQueryWithOptions(Windows.Storage.Search.QueryOptions queryOptions)Public Function CreateFileQueryWithOptions(queryOptions As Windows.Storage.Search.QueryOptions) As StorageFileQueryResult

    Parameters

    Returns

  • CreateFolderAsync(System.String)
    CreateFolderAsync(System.String)
    CreateFolderAsync(System.String)
    CreateFolderAsync(System.String)

    Creates a new child folder of the current folder.

    public IAsyncOperation<StorageFolder> CreateFolderAsync(System.String desiredName)public IAsyncOperation<StorageFolder> CreateFolderAsync(System.String desiredName)Public Function CreateFolderAsync(desiredName As System.String) As IAsyncOperation( Of StorageFolder )

    Parameters

    • desiredName
      System.String
      System.String
      System.String
      System.String

      The name of the new folder.

    Returns

    • When this method completes successfully, it returns a StorageFolder that represents the new file.

  • CreateFolderAsync(System.String,Windows.Storage.CreationCollisionOption)
    CreateFolderAsync(System.String,Windows.Storage.CreationCollisionOption)
    CreateFolderAsync(System.String,Windows.Storage.CreationCollisionOption)
    CreateFolderAsync(System.String,Windows.Storage.CreationCollisionOption)

    Creates a new child folder of the current folder, and specifies what to do if a folder with the same name already exists in the current folder.

    public IAsyncOperation<StorageFolder> CreateFolderAsync(System.String desiredName,Windows.Storage.CreationCollisionOption options)public IAsyncOperation<StorageFolder> CreateFolderAsync(System.String desiredName,Windows.Storage.CreationCollisionOption options)Public Function CreateFolderAsync(desiredName As System.String,options As Windows.Storage.CreationCollisionOption) As IAsyncOperation( Of StorageFolder )

    Parameters

    Returns

    • When this method completes successfully, it returns a StorageFolder that represents the new file.

  • CreateFolderQuery()
    CreateFolderQuery()
    CreateFolderQuery()
    CreateFolderQuery()

    Creates an object for performing filtered search queries for child StorageFolder objects of the current folder.

    public StorageFolderQueryResult CreateFolderQuery()public StorageFolderQueryResult CreateFolderQuery()Public Function CreateFolderQuery() As StorageFolderQueryResult

    Returns

  • CreateFolderQuery(Windows.Storage.Search.CommonFolderQuery)
    CreateFolderQuery(Windows.Storage.Search.CommonFolderQuery)
    CreateFolderQuery(Windows.Storage.Search.CommonFolderQuery)
    CreateFolderQuery(Windows.Storage.Search.CommonFolderQuery)

    Creates an object for performing filtered search queries for child StorageFolder objects of the current folder. Search results are grouped based on the specified folder attribute.

    public StorageFolderQueryResult CreateFolderQuery(Windows.Storage.Search.CommonFolderQuery query)public StorageFolderQueryResult CreateFolderQuery(Windows.Storage.Search.CommonFolderQuery query)Public Function CreateFolderQuery(query As Windows.Storage.Search.CommonFolderQuery) As StorageFolderQueryResult

    Parameters

    Returns

  • CreateFolderQueryWithOptions(Windows.Storage.Search.QueryOptions)
    CreateFolderQueryWithOptions(Windows.Storage.Search.QueryOptions)
    CreateFolderQueryWithOptions(Windows.Storage.Search.QueryOptions)
    CreateFolderQueryWithOptions(Windows.Storage.Search.QueryOptions)

    Creates an object used to perform filtered search queries for child StorageFolder objects of the current folder. The object is initialized with the specified query options.

    public StorageFolderQueryResult CreateFolderQueryWithOptions(Windows.Storage.Search.QueryOptions queryOptions)public StorageFolderQueryResult CreateFolderQueryWithOptions(Windows.Storage.Search.QueryOptions queryOptions)Public Function CreateFolderQueryWithOptions(queryOptions As Windows.Storage.Search.QueryOptions) As StorageFolderQueryResult

    Parameters

    Returns

  • CreateItemQuery()
    CreateItemQuery()
    CreateItemQuery()
    CreateItemQuery()

    Creates an object used to perform filtered search queries for items in the folder.

    public StorageItemQueryResult CreateItemQuery()public StorageItemQueryResult CreateItemQuery()Public Function CreateItemQuery() As StorageItemQueryResult

    Returns

  • CreateItemQueryWithOptions(Windows.Storage.Search.QueryOptions)
    CreateItemQueryWithOptions(Windows.Storage.Search.QueryOptions)
    CreateItemQueryWithOptions(Windows.Storage.Search.QueryOptions)
    CreateItemQueryWithOptions(Windows.Storage.Search.QueryOptions)

    Creates an object used to perform filtered search queries for items in the folder. The object is initialized with the specified query options.

    public StorageItemQueryResult CreateItemQueryWithOptions(Windows.Storage.Search.QueryOptions queryOptions)public StorageItemQueryResult CreateItemQueryWithOptions(Windows.Storage.Search.QueryOptions queryOptions)Public Function CreateItemQueryWithOptions(queryOptions As Windows.Storage.Search.QueryOptions) As StorageItemQueryResult

    Parameters

    Returns

  • DeleteAsync()
    DeleteAsync()
    DeleteAsync()
    DeleteAsync()

    Deletes the current folder.

    public IAsyncAction DeleteAsync()public IAsyncAction DeleteAsync()Public Function DeleteAsync() As IAsyncAction

    Returns

  • DeleteAsync(Windows.Storage.StorageDeleteOption)
    DeleteAsync(Windows.Storage.StorageDeleteOption)
    DeleteAsync(Windows.Storage.StorageDeleteOption)
    DeleteAsync(Windows.Storage.StorageDeleteOption)

    Deletes the current folder, optionally moving the deleted folder to the recycle bin.

    public IAsyncAction DeleteAsync(Windows.Storage.StorageDeleteOption option)public IAsyncAction DeleteAsync(Windows.Storage.StorageDeleteOption option)Public Function DeleteAsync(option As Windows.Storage.StorageDeleteOption) As IAsyncAction

    Parameters

    Returns

  • GetBasicPropertiesAsync()
    GetBasicPropertiesAsync()
    GetBasicPropertiesAsync()
    GetBasicPropertiesAsync()

    Retrieves the basic properties of the StorageFolder object.

    public IAsyncOperation<BasicProperties> GetBasicPropertiesAsync()public IAsyncOperation<BasicProperties> GetBasicPropertiesAsync()Public Function GetBasicPropertiesAsync() As IAsyncOperation( Of BasicProperties )

    Returns

    • When this method completes successfully, it returns a BasicProperties object.

  • GetFileAsync(System.String)
    GetFileAsync(System.String)
    GetFileAsync(System.String)
    GetFileAsync(System.String)

    Retrieves a file from the current folder.

    public IAsyncOperation<StorageFile> GetFileAsync(System.String name)public IAsyncOperation<StorageFile> GetFileAsync(System.String name)Public Function GetFileAsync(name As System.String) As IAsyncOperation( Of StorageFile )

    Parameters

    • name
      System.String
      System.String
      System.String
      System.String

      The name of the file to retrieve.

    Returns

    • When this method completes successfully, it returns a StorageFile.

  • GetFilesAsync()
    GetFilesAsync()
    GetFilesAsync()
    GetFilesAsync()

    Retrieves all files from the current folder.

    public IAsyncOperation<StorageFile>> GetFilesAsync()public IAsyncOperation<StorageFile>> GetFilesAsync()Public Function GetFilesAsync() As IAsyncOperation( Of StorageFile )

    Returns

  • GetFilesAsync(Windows.Storage.Search.CommonFileQuery)
    GetFilesAsync(Windows.Storage.Search.CommonFileQuery)
    GetFilesAsync(Windows.Storage.Search.CommonFileQuery)
    GetFilesAsync(Windows.Storage.Search.CommonFileQuery)

    Retrieves files from the current folder based on a common folder query.

    public IAsyncOperation<StorageFile>> GetFilesAsync(Windows.Storage.Search.CommonFileQuery query)public IAsyncOperation<StorageFile>> GetFilesAsync(Windows.Storage.Search.CommonFileQuery query)Public Function GetFilesAsync(query As Windows.Storage.Search.CommonFileQuery) As IAsyncOperation( Of StorageFile )

    Parameters

    Returns

  • GetFilesAsync(Windows.Storage.Search.CommonFileQuery,System.UInt32,System.UInt32)
    GetFilesAsync(Windows.Storage.Search.CommonFileQuery,System.UInt32,System.UInt32)
    GetFilesAsync(Windows.Storage.Search.CommonFileQuery,System.UInt32,System.UInt32)
    GetFilesAsync(Windows.Storage.Search.CommonFileQuery,System.UInt32,System.UInt32)

    Retrieves a range of files from the current folder based on a common file query.

    public IAsyncOperation<StorageFile>> GetFilesAsync(Windows.Storage.Search.CommonFileQuery query,System.UInt32 startIndex,System.UInt32 maxItemsToRetrieve)public IAsyncOperation<StorageFile>> GetFilesAsync(Windows.Storage.Search.CommonFileQuery query,System.UInt32 startIndex,System.UInt32 maxItemsToRetrieve)Public Function GetFilesAsync(query As Windows.Storage.Search.CommonFileQuery,startIndex As System.UInt32,maxItemsToRetrieve As System.UInt32) As IAsyncOperation( Of StorageFile )

    Parameters

    • query

      The common file query.

    • startIndex
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

      The zero-based index of the first file in the range.

    • maxItemsToRetrieve
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

      The maximum number of files to retrieve.

    Returns

  • GetFolderAsync(System.String)
    GetFolderAsync(System.String)
    GetFolderAsync(System.String)
    GetFolderAsync(System.String)

    Retrieves the specified child folder from the current folder.

    public IAsyncOperation<StorageFolder> GetFolderAsync(System.String name)public IAsyncOperation<StorageFolder> GetFolderAsync(System.String name)Public Function GetFolderAsync(name As System.String) As IAsyncOperation( Of StorageFolder )

    Parameters

    • name
      System.String
      System.String
      System.String
      System.String

      The name of the child folder to retrieve.

    Returns

    • When this method completes successfully, it returns a StorageFolder that represents the specified child folder.

  • GetFoldersAsync()
    GetFoldersAsync()
    GetFoldersAsync()
    GetFoldersAsync()

    Retrieves all child folders from the current folder.

    public IAsyncOperation<StorageFolder>> GetFoldersAsync()public IAsyncOperation<StorageFolder>> GetFoldersAsync()Public Function GetFoldersAsync() As IAsyncOperation( Of StorageFolder )

    Returns

    • When this method completes successfully, it returns the list (type IVectorView<T> ) of child folders. Each child folder in this list is represented by a StorageFolder object.

  • GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery)
    GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery)
    GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery)
    GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery)

    Retrieves child folders from the current folder based on a common folder query.

    public IAsyncOperation<StorageFolder>> GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery query)public IAsyncOperation<StorageFolder>> GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery query)Public Function GetFoldersAsync(query As Windows.Storage.Search.CommonFolderQuery) As IAsyncOperation( Of StorageFolder )

    Parameters

    Returns

    • When this method completes successfully, it returns the list (type IVectorView<T> ) of child folders. Each child folder in this list is represented by a StorageFolder object.

  • GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery,System.UInt32,System.UInt32)
    GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery,System.UInt32,System.UInt32)
    GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery,System.UInt32,System.UInt32)
    GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery,System.UInt32,System.UInt32)

    Retrieves a range of child folders from the current folder based on a common folder query.

    public IAsyncOperation<StorageFolder>> GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery query,System.UInt32 startIndex,System.UInt32 maxItemsToRetrieve)public IAsyncOperation<StorageFolder>> GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery query,System.UInt32 startIndex,System.UInt32 maxItemsToRetrieve)Public Function GetFoldersAsync(query As Windows.Storage.Search.CommonFolderQuery,startIndex As System.UInt32,maxItemsToRetrieve As System.UInt32) As IAsyncOperation( Of StorageFolder )

    Parameters

    • query

      The common folder query.

    • startIndex
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

      The zero-based index of the first child folder in the range.

    • maxItemsToRetrieve
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

      The maximum number of child folders to retrieve.

    Returns

    • When this method completes successfully, it returns the list (type IVectorView<T> ) of child folders. Each child folder in this list is represented by a StorageFolder object.

  • GetIndexedStateAsync()
    GetIndexedStateAsync()
    GetIndexedStateAsync()
    GetIndexedStateAsync()

    Retrieves the indexed state of the folder.

    public IAsyncOperation<IndexedState> GetIndexedStateAsync()public IAsyncOperation<IndexedState> GetIndexedStateAsync()Public Function GetIndexedStateAsync() As IAsyncOperation( Of IndexedState )

    Returns

    • When this method completes successfully, it returns an IndexedState enumeration value.

  • GetItemAsync(System.String)
    GetItemAsync(System.String)
    GetItemAsync(System.String)
    GetItemAsync(System.String)

    Retrieves an item from the folder.

    public IAsyncOperation<IStorageItem> GetItemAsync(System.String name)public IAsyncOperation<IStorageItem> GetItemAsync(System.String name)Public Function GetItemAsync(name As System.String) As IAsyncOperation( Of IStorageItem )

    Parameters

    • name
      System.String
      System.String
      System.String
      System.String

      The name of the item to retrieve.

    Returns

    • When this method completes successfully, it returns the item (type IStorageItem ).

  • GetItemsAsync()
    GetItemsAsync()
    GetItemsAsync()
    GetItemsAsync()

    Retrieves all items from the current folder.

    public IAsyncOperation<IStorageItem>> GetItemsAsync()public IAsyncOperation<IStorageItem>> GetItemsAsync()Public Function GetItemsAsync() As IAsyncOperation( Of IStorageItem )

    Returns

    • When this method completes successfully, it returns the list (type IVectorView<T> ) of items.

  • GetItemsAsync(System.UInt32,System.UInt32)
    GetItemsAsync(System.UInt32,System.UInt32)
    GetItemsAsync(System.UInt32,System.UInt32)
    GetItemsAsync(System.UInt32,System.UInt32)

    Retrieves a range of items from the current folder.

    public IAsyncOperation<IStorageItem>> GetItemsAsync(System.UInt32 startIndex,System.UInt32 maxItemsToRetrieve)public IAsyncOperation<IStorageItem>> GetItemsAsync(System.UInt32 startIndex,System.UInt32 maxItemsToRetrieve)Public Function GetItemsAsync(startIndex As System.UInt32,maxItemsToRetrieve As System.UInt32) As IAsyncOperation( Of IStorageItem )

    Parameters

    • startIndex
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

      The zero-based index of the first item in the range.

    • maxItemsToRetrieve
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

      The maximum number of items to retrieve.

    Returns

    • When this method completes successfully, it returns the list (type IVectorView<T> ) of items.

  • GetParentAsync()
    GetParentAsync()
    GetParentAsync()
    GetParentAsync()

    Gets the parent folder of the current folder.

    public IAsyncOperation<StorageFolder> GetParentAsync()public IAsyncOperation<StorageFolder> GetParentAsync()Public Function GetParentAsync() As IAsyncOperation( Of StorageFolder )

    Returns

    • When this method completes, it returns the parent folder as a StorageFolder.

  • GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode)
    GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode)
    GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode)
    GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode)

    Retrieves the thumbnail that is associated with the StorageFolder.

    public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode mode)public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode mode)Public Function GetThumbnailAsync(mode As Windows.Storage.FileProperties.ThumbnailMode) As IAsyncOperation( Of StorageItemThumbnail )

    Parameters

    Returns

    • When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

  • GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32)
    GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32)
    GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32)
    GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32)

    Retrieves the thumbnail that is associated with the StorageFolder, scaling it to the specified size.

    public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode mode,System.UInt32 requestedSize)public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode mode,System.UInt32 requestedSize)Public Function GetThumbnailAsync(mode As Windows.Storage.FileProperties.ThumbnailMode,requestedSize As System.UInt32) As IAsyncOperation( Of StorageItemThumbnail )

    Parameters

    Returns

    • When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

  • GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32,Windows.Storage.FileProperties.ThumbnailOptions)
    GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32,Windows.Storage.FileProperties.ThumbnailOptions)
    GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32,Windows.Storage.FileProperties.ThumbnailOptions)
    GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32,Windows.Storage.FileProperties.ThumbnailOptions)

    Retrieves the thumbnail that is associated with the StorageFolder, based on the specified options.

    public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode mode,System.UInt32 requestedSize,Windows.Storage.FileProperties.ThumbnailOptions options)public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode mode,System.UInt32 requestedSize,Windows.Storage.FileProperties.ThumbnailOptions options)Public Function GetThumbnailAsync(mode As Windows.Storage.FileProperties.ThumbnailMode,requestedSize As System.UInt32,options As Windows.Storage.FileProperties.ThumbnailOptions) As IAsyncOperation( Of StorageItemThumbnail )

    Parameters

    Returns

    • When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

  • IsCommonFileQuerySupported(Windows.Storage.Search.CommonFileQuery)
    IsCommonFileQuerySupported(Windows.Storage.Search.CommonFileQuery)
    IsCommonFileQuerySupported(Windows.Storage.Search.CommonFileQuery)
    IsCommonFileQuerySupported(Windows.Storage.Search.CommonFileQuery)

    Retrieves a value that indicates whether the current folder supports the specified common file query.

    public bool IsCommonFileQuerySupported(Windows.Storage.Search.CommonFileQuery query)public bool IsCommonFileQuerySupported(Windows.Storage.Search.CommonFileQuery query)Public Function IsCommonFileQuerySupported(query As Windows.Storage.Search.CommonFileQuery) As bool

    Parameters

    Returns

    • bool
      bool
      bool
      bool

      True if the folder supports the specified common file query; otherwise false.

  • IsCommonFolderQuerySupported(Windows.Storage.Search.CommonFolderQuery)
    IsCommonFolderQuerySupported(Windows.Storage.Search.CommonFolderQuery)
    IsCommonFolderQuerySupported(Windows.Storage.Search.CommonFolderQuery)
    IsCommonFolderQuerySupported(Windows.Storage.Search.CommonFolderQuery)

    Retrieves a value that indicates whether the current folder supports the specified common folder query.

    public bool IsCommonFolderQuerySupported(Windows.Storage.Search.CommonFolderQuery query)public bool IsCommonFolderQuerySupported(Windows.Storage.Search.CommonFolderQuery query)Public Function IsCommonFolderQuerySupported(query As Windows.Storage.Search.CommonFolderQuery) As bool

    Parameters

    Returns

    • bool
      bool
      bool
      bool

      True if the folder supports the specified common folder query; otherwise false.

  • IsEqual(Windows.Storage.IStorageItem)
    IsEqual(Windows.Storage.IStorageItem)
    IsEqual(Windows.Storage.IStorageItem)
    IsEqual(Windows.Storage.IStorageItem)

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

    public bool IsEqual(Windows.Storage.IStorageItem item)public bool IsEqual(Windows.Storage.IStorageItem item)Public Function IsEqual(item As Windows.Storage.IStorageItem) As bool

    Parameters

    Returns

    • bool
      bool
      bool
      bool

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

  • IsOfType(Windows.Storage.StorageItemTypes)
    IsOfType(Windows.Storage.StorageItemTypes)
    IsOfType(Windows.Storage.StorageItemTypes)
    IsOfType(Windows.Storage.StorageItemTypes)

    Determines whether the loaded StorageFolder is the specified type.

    public bool IsOfType(Windows.Storage.StorageItemTypes type)public bool IsOfType(Windows.Storage.StorageItemTypes type)Public Function IsOfType(type As Windows.Storage.StorageItemTypes) As bool

    Parameters

    Returns

    • bool
      bool
      bool
      bool

      True if the loaded StorageFolder is the specified type; otherwise false.

  • RenameAsync(System.String)
    RenameAsync(System.String)
    RenameAsync(System.String)
    RenameAsync(System.String)

    Renames the StorageFolder.

    public IAsyncAction RenameAsync(System.String desiredName)public IAsyncAction RenameAsync(System.String desiredName)Public Function RenameAsync(desiredName As System.String) As IAsyncAction

    Parameters

    • desiredName
      System.String
      System.String
      System.String
      System.String

      The new name.

    Returns

  • RenameAsync(System.String,Windows.Storage.NameCollisionOption)
    RenameAsync(System.String,Windows.Storage.NameCollisionOption)
    RenameAsync(System.String,Windows.Storage.NameCollisionOption)
    RenameAsync(System.String,Windows.Storage.NameCollisionOption)

    Renames the StorageFolder, and specifies what to do if a folder with the same name already exists.

    public IAsyncAction RenameAsync(System.String desiredName,Windows.Storage.NameCollisionOption option)public IAsyncAction RenameAsync(System.String desiredName,Windows.Storage.NameCollisionOption option)Public Function RenameAsync(desiredName As System.String,option As Windows.Storage.NameCollisionOption) As IAsyncAction

    Parameters

    Returns

  • TryGetItemAsync(System.String)
    TryGetItemAsync(System.String)
    TryGetItemAsync(System.String)
    TryGetItemAsync(System.String)

    Try to get a specific file or sub-folder from the current folder using the name of the file or folder to get.

    public IAsyncOperation<IStorageItem> TryGetItemAsync(System.String name)public IAsyncOperation<IStorageItem> TryGetItemAsync(System.String name)Public Function TryGetItemAsync(name As System.String) As IAsyncOperation( Of IStorageItem )

    Parameters

    • name
      System.String
      System.String
      System.String
      System.String

      The name (or path relative to the current folder) of the file or sub-folder to try to retrieve.

    Returns

    • When this method completes successfully, it returns the file or folder (type IStorageItem ).

Events

  • PropertiesUpdated
    PropertiesUpdated
    PropertiesUpdated
    PropertiesUpdated

    Occurs when one or more of the StorageFolder 's properties is updated.

    public event TypedEventHandler PropertiesUpdatedpublic event TypedEventHandler PropertiesUpdatedPublic Event PropertiesUpdated
  • ThumbnailUpdated
    ThumbnailUpdated
    ThumbnailUpdated
    ThumbnailUpdated

    Fires when the StorageFolder 's thumbnail is updated or a better quality thumbnail is available.

    public event TypedEventHandler ThumbnailUpdatedpublic event TypedEventHandler ThumbnailUpdatedPublic Event ThumbnailUpdated

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute

Details

Assembly

Windows.Storage.BulkAccess.dll