IXpsOMVisualBrush::GetVisualLookup method

Gets the lookup key name of a visual in a resource dictionary; the visual is to be used as the source for the brush.

Syntax

HRESULT GetVisualLookup(
  [out, retval] LPWSTR *lookup
);

Parameters

  • lookup [out, retval]
    The key name of a visual in a resource dictionary; the visual is to be used as the source for the brush. If a visual's lookup key has not been set, or if a local visual has been set, a NULL pointer is returned.

    Most recent method called Object that is returned in lookup

    SetVisualLocal

    NULL pointer.

    SetVisualLookup

    The lookup key that is set by SetVisualLookup.

    Neither SetVisualLocal nor SetVisualLookup has been called yet.

    NULL pointer.

     

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code Description
S_OK

The method succeeded.

E_POINTER

lookup is NULL.

 

Remarks

This method allocates the memory used by the string that is returned in lookup. If lookup is not NULL, use the CoTaskMemFree function to free the memory.

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps]

Header

Xpsobjectmodel.h

IDL

XpsObjectModel.idl

See also

IXpsOMVisualBrush

XML Paper Specification