HyphenateProc function (richedit.h)

Article
10/13/2021

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

void HyphenateProc(
  [in]  WCHAR      *pszWord,
  [in]  LANGID     langid,
  [in]  long       ichExceed,
  [out] HYPHRESULT *phyphresult
);

Parameters

[in] pszWord

Type: WCHAR*

Pointer to the word to hyphenate.

[in] langid

Type: LANGID

Current language ID for the control.

[in] ichExceed

Type: LONG

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

[out] phyphresult

Type: HYPHRESULT*

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

Return value

None

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

Requirement	Value
Minimum supported client	Windows XP with SP1 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	richedit.h