IInkEdit::get_MaxLength method (inked.h)

Article
02/22/2024

Gets or sets a value indicating whether there is a maximum number of characters an InkEdit control can hold and, if so, specifies the maximum number of characters.

This property is read/write.

Syntax

HRESULT get_MaxLength(
  long *plMaxLength
);

Parameters

plMaxLength

Return value

None

Remarks

The default for the MaxLength property is 0, indicating no maximum other than that created by memory constraints on the user's system. Any number greater than 0 indicates the maximum number of characters.

Use the MaxLength property to limit the number of characters a user can enter in an InkEdit control.

If text that exceeds the MaxLength property setting is assigned to an InkEdit control from code, no error occurs; however, only the maximum number of characters is assigned to the Text property, and extra characters are truncated. Changing this property doesn't affect the current contents of an InkEdit control, but will affect any subsequent changes to the contents.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	inked.h
Library	InkEd.dll