This topic has not yet been rated - Rate this topic

HyphenateProc callback function

Applies to: desktop apps only

The HyphenateProc function is an application–defined callback function used with the EM_SETHYPHENATEINFO message. It determines how hyphenation is done in a Microsoft Rich Edit control.

Syntax

Copy

void CALLBACK HyphenateProc(
  __in   WCHAR *pszWord,
  __in   LANGID langid,
  __in   LONG ichExceed,
  __out  HYPHRESULT *phyphresult
);

Parameters

pszWord [in]

Type: WCHAR*

Pointer to the word to hyphenate.

langid [in]

Type: LANGID

Current language ID for the control.

ichExceed [in]

Type: LONG

Index of the character in the passed string that exceeds the line width.

phyphresult [out]

Type: HYPHRESULT*

Pointer to a HYPHRESULT structure that HyphenateProc fills in with the result of the hyphenation.

Return value

There is no return value.

Remarks

HyphenateProc is a placeholder for the application-defined function name.

An application must install the callback function by specifying the address of the callback function in an EM_SETHYPHENATEINFO message.

Requirements