nw::lyt::TextBox::SetString Member Function

Syntax

virtual u16 SetString(
     const wchar_t*                  str,
     u16 dstIdx,
     u16 strLen
);

Arguments

Name Description
str The text string to be stored.
dstIdx The storage location.
strLen Length of the text string to be stored

Return Values

Returns the length of the stored text string.

Description

Stores a text string in the text buffer.

The length of the text string is specified by strLen. The NULL terminator is not detected.

Should the length of the specified string exceed that of the text buffer, the portion that exceeds the length of the text buffer will be cut off.

See Also

GetString
GetStringLength

Revision History

2010/04/09
There was a mistake in the description regarding when the value of strLen is 0. A value of 0 does not include the null terminator.
2009/09/18
Initial version.

CONFIDENTIAL