Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IDXSurface::GetAppData Method

This topic documents a feature of Visual Filters and Transitions, which is deprecated as of Windows Internet Explorer 9 and obsolete as of Internet Explorer 10.

Retrieves an application-specific DWORD of data.

Syntax


HRESULT GetAppData(
    DWORD_PTR *pdwAppData
);

Parameters

pdwAppData
[out] Pointer to a DWORD of data that was set with the IDXSurface::SetAppData method. If no call has been made to IDXSurface::SetAppData, the value returned is 0.

Return Value

Returns S_OK for success or E_POINTER to indicate a NULL pointer argument; these are the only valid return values. The call does not fail if a valid pointer is given.

Remarks

This method retrieves a tag set by an application for a DXSurface. For example, applications that use 2-D transforms can use this method to retrieve a tag from a transform input surface. This enables the application to identify which surfaces were hit when doing 2-D hit testing. However, applications can use this data in any way that is useful.

All surface implementations must support IDXSurface::SetAppData and IDXSurface::GetAppData.

See Also

IDXSurface::SetAppData
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.