Share via


IXRImageBrush::GetImageSource (Compact 2013)

3/28/2014

This method retrieves the image displayed by this image brush.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetImageSource(
    IXRImageSource** ppImageSource
) = 0;

Parameters

  • ppImageSource
    [out] Address of a pointer to an object derived from IXRImageSource that contains the image displayed by this image brush.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

The underlying IXRImageSource instance that represents the graphical image is usually an IXRBitmapImage, which is a derived class.

If the initial ImageSource attribute value in the source XAML for your application does not specify a valid source, the ImageFailed event can occur when this method is called.

To create an undisplayed placeholder, you can specify an initial value in Microsoft Silverlight 3 XAML of "" (empty string) and then set the value in C++ code later.

To use a specific interface pointer type, you can use the helper template version of this method that XAML for Windows Embedded provides. When you supply a derived type, this version automatically supplies a type-safe method that implicitly converts the returned type from a generic interface so you do not have to explicitly call IUnknown::QueryInterface to convert the generic interface into the required object type.

.NET Framework Equivalent

System.Windows.Media.ImageBrush.ImageSource

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

IXRImageBrush
IXRImageBrush::SetImageSource