ITextStory::GetActive method

Sets the active state of a story.

Syntax


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

Parameters

pValue [out, retval]

Type: long*

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

ValueMeaning
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.

 

Return value

Type: HRESULT

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

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

IDL

Tom.idl

See also

ITextStory
ITextStory::SetActive

 

 

Community Additions

ADD
Show:
© 2014 Microsoft