QueryOptions.SetThumbnailPrefetch Method

  • Reference

Definition

Namespace:
Windows.Storage.Search
Edit

Specifies the type and size of thumbnails that the system should start loading immediately when items are accessed (instead of retrieving them on a case-by-case basis). This uses more resources but makes thumbnail retrieval on query results faster.

public:
 virtual void SetThumbnailPrefetch(ThumbnailMode mode, unsigned int requestedSize, ThumbnailOptions options) = SetThumbnailPrefetch;
void SetThumbnailPrefetch(ThumbnailMode const& mode, uint32_t const& requestedSize, ThumbnailOptions const& options);
public void SetThumbnailPrefetch(ThumbnailMode mode, uint requestedSize, ThumbnailOptions options);
function setThumbnailPrefetch(mode, requestedSize, options)
Public Sub SetThumbnailPrefetch (mode As ThumbnailMode, requestedSize As UInteger, options As ThumbnailOptions)

Parameters

mode
ThumbnailMode

The enumeration value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted.

For guidance about choosing the best thumbnail mode, see Guidelines and checklist for thumbnails.

requestedSize
UInt32

unsigned int

uint32_t

The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the requestedSize as a guide and tries to return a thumbnail image that can be scaled to the requested size without reducing the quality of the image.

If Windows can't find a thumbnail image that exactly meets the requested size, a larger thumbnail might be returned. If no larger thumbnail is available, a thumbnail image that is smaller than the requested size might be returned.

options
ThumbnailOptions

The enum value that describes the desired behavior to use to retrieve the thumbnail image. The specified behavior might affect the size and/or quality of the image and how quickly the thumbnail image is retrieved.

Applies to

See also