ITextFont2::SetCookie method

Sets the client cookie.

Syntax


HRESULT SetCookie(
  [in]  long Value
);

Parameters

Value [in]

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. It has no meaning to the Text Object Model (TOM) engine except that 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::GetCookie

 

 

Community Additions

ADD
Show:
© 2015 Microsoft