ClaimedLineDisplay.TryStoreStorageFileBitmapAsync Method
Definition
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.
Overloads
| TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) |
Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device. |
| TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) |
Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device. |
| TryStoreStorageFileBitmapAsync(StorageFile) |
Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device. |
TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment)
Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.
public:
virtual IAsyncOperation<LineDisplayStoredBitmap ^> ^ TryStoreStorageFileBitmapAsync(StorageFile ^ bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment) = TryStoreStorageFileBitmapAsync;/// [Windows.Foundation.Metadata.Overload("TryStoreStorageFileBitmapWithAlignmentAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile const& bitmap, LineDisplayHorizontalAlignment const& horizontalAlignment, LineDisplayVerticalAlignment const& verticalAlignment);[Windows.Foundation.Metadata.Overload("TryStoreStorageFileBitmapWithAlignmentAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment);function tryStoreStorageFileBitmapAsync(bitmap, horizontalAlignment, verticalAlignment)Public Function TryStoreStorageFileBitmapAsync (bitmap As StorageFile, horizontalAlignment As LineDisplayHorizontalAlignment, verticalAlignment As LineDisplayVerticalAlignment) As IAsyncOperation(Of LineDisplayStoredBitmap)Parameters
- bitmap
- StorageFile
A StorageFile that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats.
- horizontalAlignment
- LineDisplayHorizontalAlignment
Determines how the bitmap will be horizontally aligned relative to its originating character cell.
- verticalAlignment
- LineDisplayVerticalAlignment
Determines how the bitmap will be vertically aligned relative to its originating character cell.
Returns
True if the bitmap is stored successfully, False if a failure occurs.
- Attributes
Windows requirements
| Device family |
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v5.0)
|
Remarks
- The bitmap StorageFile must be backed by a local file. If it is created from a stream, a URI or another source this method will throw an exception.
- Calling this method when LineDisplayCapabiliaties.CanDisplayBitmaps is False will result in an exception.
- Up to 100 bitmaps can be stored using this method. Attempting to store more than 100 bitmaps will result in an exception. Delete unused bitmaps using LineDisplayStoredBitmap.TryDeleteAsync.
See also
Applies to
TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32)
Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.
public:
virtual IAsyncOperation<LineDisplayStoredBitmap ^> ^ TryStoreStorageFileBitmapAsync(StorageFile ^ bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment, int widthInPixels) = TryStoreStorageFileBitmapAsync;/// [Windows.Foundation.Metadata.Overload("TryStoreStorageFileBitmapWithAlignmentAndWidthAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile const& bitmap, LineDisplayHorizontalAlignment const& horizontalAlignment, LineDisplayVerticalAlignment const& verticalAlignment, int const& widthInPixels);[Windows.Foundation.Metadata.Overload("TryStoreStorageFileBitmapWithAlignmentAndWidthAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment, int widthInPixels);function tryStoreStorageFileBitmapAsync(bitmap, horizontalAlignment, verticalAlignment, widthInPixels)Public Function TryStoreStorageFileBitmapAsync (bitmap As StorageFile, horizontalAlignment As LineDisplayHorizontalAlignment, verticalAlignment As LineDisplayVerticalAlignment, widthInPixels As Integer) As IAsyncOperation(Of LineDisplayStoredBitmap)Parameters
- bitmap
- StorageFile
A StorageFile that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats.
- horizontalAlignment
- LineDisplayHorizontalAlignment
Determines how the bitmap will be horizontally aligned relative to its originating character cell.
- verticalAlignment
- LineDisplayVerticalAlignment
Determines how the bitmap will be vertically aligned relative to its originating character cell.
- widthInPixels
-
Int32
int
The displayed bitmap width in pixels, if different from the original bitmap width. Height will be calculated proportionally.
Returns
True if the bitmap is stored successfully, False if a failure occurs.
- Attributes
Windows requirements
| Device family |
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v5.0)
|
Remarks
- The bitmap StorageFile must be backed by a local file. If it is created from a stream, a URI or another source this method will throw an exception.
- Calling this method when LineDisplayCapabiliaties.CanDisplayBitmaps is False will result in an exception.
- Up to 100 bitmaps can be stored using this method. Attempting to store more than 100 bitmaps will result in an exception. Delete unused bitmaps using LineDisplayStoredBitmap.TryDeleteAsync.
- Passing a bitmap width greater than ClaimedLineDisplay.MaxBitmapSizeInPixels will result in an exception.
See also
Applies to
TryStoreStorageFileBitmapAsync(StorageFile)
Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.
public:
virtual IAsyncOperation<LineDisplayStoredBitmap ^> ^ TryStoreStorageFileBitmapAsync(StorageFile ^ bitmap) = TryStoreStorageFileBitmapAsync;/// [Windows.Foundation.Metadata.Overload("TryStoreStorageFileBitmapAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile const& bitmap);[Windows.Foundation.Metadata.Overload("TryStoreStorageFileBitmapAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile bitmap);function tryStoreStorageFileBitmapAsync(bitmap)Public Function TryStoreStorageFileBitmapAsync (bitmap As StorageFile) As IAsyncOperation(Of LineDisplayStoredBitmap)Parameters
- bitmap
- StorageFile
A StorageFile that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats.
Returns
True if the bitmap is stored successfully, False if a failure occurs.
- Attributes
Windows requirements
| Device family |
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v5.0)
|
Remarks
- The bitmap StorageFile must be backed by a local file. If it is created from a stream, a URI or another source this method will throw an exception.
- Calling this method when LineDisplayCapabiliaties.CanDisplayBitmaps is False will result in an exception.
- Up to 100 bitmaps can be stored using this method. Attempting to store more than 100 bitmaps will result in an exception. Delete unused bitmaps using LineDisplayStoredBitmap.TryDeleteAsync.