ITextFont2::GetCookie method

Gets the client cookie.

Syntax


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

Parameters

pValue [out, retval]

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

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

ITextFont2
ITextFont2::SetCookie

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.