IDirectManipulationViewport::GetTag method (directmanipulation.h)

Gets the tag value of a viewport.

Syntax

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

Parameters

[in] riid

IID to the interface.

[out, optional] object

The object portion of the tag.

[out, optional] id

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

See also

IDirectManipulationViewport