Edit

ITextFont2::GetCookie method (tom.h)

  • Article

Gets the client cookie.

Syntax

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

Parameters

[out, retval] pValue

Type: long*

The client cookie.

Return value

Type: HRESULT

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

Remarks

This value is purely for the use of the client and has no meaning to the Text Object Model (TOM) engine. There are exceptions where different values correspond to different character format runs.

Requirements

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
DLL Msftedit.dll

See also

ITextFont2

ITextFont2::SetCookie