BitmapEffect.CreateBitmapEffectOuter Method

Reference

Definition

Namespace:: System.Windows.Media.Effects

Assembly:: PresentationCore.dll

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.

Caution

BitmapEffects are deprecated and no longer function. Consider using Effects where appropriate instead.

Creates a handle to an IMILBitmapEffect object that is used to initialize a custom effect.

protected:
 static System::Runtime::InteropServices::SafeHandle ^ CreateBitmapEffectOuter();

[System.Security.SecurityCritical]
[System.Security.SecurityTreatAsSafe]
protected static System.Runtime.InteropServices.SafeHandle CreateBitmapEffectOuter();

[System.Security.SecurityCritical]
[System.Security.SecurityTreatAsSafe]
[System.Obsolete("BitmapEffects are deprecated and no longer function.  Consider using Effects where appropriate instead.")]
protected static System.Runtime.InteropServices.SafeHandle CreateBitmapEffectOuter();

[System.Obsolete("BitmapEffects are deprecated and no longer function.  Consider using Effects where appropriate instead.")]
protected static System.Runtime.InteropServices.SafeHandle CreateBitmapEffectOuter();

[<System.Security.SecurityCritical>]
[<System.Security.SecurityTreatAsSafe>]
static member CreateBitmapEffectOuter : unit -> System.Runtime.InteropServices.SafeHandle

[<System.Security.SecurityCritical>]
[<System.Security.SecurityTreatAsSafe>]
[<System.Obsolete("BitmapEffects are deprecated and no longer function.  Consider using Effects where appropriate instead.")>]
static member CreateBitmapEffectOuter : unit -> System.Runtime.InteropServices.SafeHandle

[<System.Obsolete("BitmapEffects are deprecated and no longer function.  Consider using Effects where appropriate instead.")>]
static member CreateBitmapEffectOuter : unit -> System.Runtime.InteropServices.SafeHandle

Protected Shared Function CreateBitmapEffectOuter () As SafeHandle

Returns

SafeHandle

A handle to an IMILBitmapEffect object.

Attributes: SecurityCriticalAttribute SecurityTreatAsSafeAttribute ObsoleteAttribute

Examples

The following example shows an implementation of CreateUnmanagedEffect that uses the CreateBitmapEffectOuter method to retrieve a wrapper effect object.

unsafe protected override SafeHandle CreateUnmanagedEffect()
{
    const uint CLSCTX_INPROC_SERVER = 1;
    Guid IID_IUnknown = new Guid("00000000-0000-0000-C000-000000000046");
    Guid guidEffectCLSID = new Guid("84CF07CC-34C4-460f-B435-3184F5F2FF2A");
    SafeHandle wrapper = BitmapEffect.CreateBitmapEffectOuter();

    COMSafeHandle unmanagedEffect;
    uint hresult = Ole32Methods.CoCreateInstance(
                        ref guidEffectCLSID,
                        wrapper.DangerousGetHandle(),
                        CLSCTX_INPROC_SERVER,
                        ref IID_IUnknown,
                        out unmanagedEffect);
    InitializeBitmapEffect(wrapper, unmanagedEffect);
    if (0 == hresult) return wrapper;
    throw new Exception("Cannot instantiate effect. HRESULT = " + hresult.ToString());
}

<SecurityPermissionAttribute(SecurityAction.Demand, Flags := SecurityPermissionFlag.UnmanagedCode)>
Protected Overrides Function CreateUnmanagedEffect() As SafeHandle
    Const CLSCTX_INPROC_SERVER As UInteger = 1
    Dim IID_IUnknown As New Guid("00000000-0000-0000-C000-000000000046")
    Dim guidEffectCLSID As New Guid("84CF07CC-34C4-460f-B435-3184F5F2FF2A")
    Dim wrapper As SafeHandle = BitmapEffect.CreateBitmapEffectOuter()

    Dim unmanagedEffect As COMSafeHandle
    Dim hresult As UInteger = Ole32Methods.CoCreateInstance(guidEffectCLSID, wrapper.DangerousGetHandle(), CLSCTX_INPROC_SERVER, IID_IUnknown, unmanagedEffect)
    InitializeBitmapEffect(wrapper, unmanagedEffect)
    If 0 = hresult Then
        Return wrapper
    End If
    Throw New Exception("Cannot instantiate effect. HRESULT = " & hresult.ToString())
End Function

Remarks

Framework interaction with custom effects is handled through an IMILBitmapEffect object. The outer effect is initialized with the custom effect through the InitializeBitmapEffect method.

Applies to

Product	Versions (Obsolete)
.NET Framework	3.0, 3.5 (4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1)
Windows Desktop	(3.0, 3.1, 5, 6, 7, 8, 9, 10)

Share via