Skip to main content
IDirectManipulationViewport::GetTag method

Gets the tag value of a viewport.

Syntax


HRESULT GetTag(
  [in]            REFIID riid,
  [out, optional] void   **object,
  [out, optional] UINT32 *id
);

Parameters

riid [in]

IID to the interface.

object [out, optional]

The object portion of the tag.

id [out, optional]

The identifier portion of the tag.

Return value

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

A tag is a pairing of an integer ID with a Component Object Model (COM) object. It can be used by an app to identify the viewport.

The out parameters are optional, so the method can return an ID, the viewport object, or both.

Examples

The following example show how to use this method.


IUnknown* pUnk;
UINT32 id;

HRESULT hr = pRegion->GetTag(IID_PPV_ARGS(&pUnk), &id); 

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

DirectManipulation.h

IDL

DirectManipulation.idl

IID

IID_IDirectManipulationViewport is defined as 28b85a3d-60a0-48bd-9ba1-5ce8d9ea3a6d

See also

IDirectManipulationViewport