Controls.StringToCursor Function

Returns a TCursor value given its string representation.

Pascal

function StringToCursor(const S: string): TCursor;

C++

TCursor StringToCursor(const AnsiString S);

File

Controls

Description

Call StringToCursor to reverse the translation performed by CursorToString. This method is useful for converting the strings entered by the user into useable TCursor values.

The S parameter can be either the name of a built-in cursor constant such as "crHelp", or the string representation of a valid TCursor value such as "10". StringToCursor returns the TCursor value that corresponds to the S parameter.

Note: The value returned by StringToCursor is not guaranteed to be a valid cursor. If the Cursors property of the global Screen variable does not include a corresponding entry, the value returned by StringToCursor can not be used to set the Cursor property of a control.