ITextStory::GetActive method (tom.h)

Sets the active state of a story.

Syntax

HRESULT GetActive(
  [out, retval] long *pValue
);

[out, retval] pValue

Type: long*

The active state. It can be one of the following values.

Value	Meaning
tomDisplayActive	The story has no UI or display (fast and lightweight).
tomDisplayUIActive	The story is UI active; that is, gets keyboard and mouse interactions.
tomInactive	The story has display, but no UI.
tomUIActive	The story has display and UI activity.

Type: HRESULT

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

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