Edit

ITextFont::GetAnimation method (tom.h)

  • Article

Gets the animation type.

Syntax

HRESULT GetAnimation(
  long *pValue
);

Parameters

pValue

Type: long*

One of the following animation types.

tomNoAnimation tomLasVegasLights tomBlinkingBackground tomSparkleText tomMarchingBlackAnts tomMarchingRedAnts tomShimmer tomWipeDown tomWipeRight

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return code Description
E_INVALIDARG
 Invalid argument.
CO_E_RELEASED
 The font object is attached to a range that has been deleted.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header tom.h
DLL Msftedit.dll

See also

Conceptual

ITextFont

Reference

SetAnimation

Text Object Model