get_child_text


template <class character>
unsigned get_child_text(handle window,
                        unsigned identity,
                        character* buffer,
                        unsigned length)

This function obtains the text of a child window.

Parameters

handle window

The handle of the parent window.

unsigned identity

The identity of the child window containing the text.

character* buffer

A pointer to a buffer that is updated to hold the text.

unsigned length

The length (in characters) of the buffer pointed to by the previous parameter.

Return

unsigned

Zero The call failed.
Other The number of characters transferred to the buffer - not including the null terminator.

Notes

The text is truncated to fit the buffer when it exceeds the specified buffer length.

The message message::get_text is sent to the control to obtain the text.