Edit

IDirectManipulationViewport::SetTag method (directmanipulation.h)

  • Article

Sets a viewport tag.

Syntax

HRESULT SetTag(
  [in, optional] IUnknown *object,
  [in]           UINT32   id
);

Parameters

[in, optional] object

The object portion of the tag.

[in] id

The ID 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 object parameter is optional, so that the method can set just an ID.

Examples

The following example shows the syntax for this method.

IUnknown* pUnk = ...;
UINT32 id = ...;

HRESULT hr = pRegion->SetTag(pUnk, id);

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header directmanipulation.h

See also

IDirectManipulationViewport