Vcl.Controls.IdentToCursor

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function IdentToCursor(const Ident: string; var Cursor: Longint): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall IdentToCursor(const System::UnicodeString Ident, System::LongInt &Cursor);

Properties

Type Visibility Source Unit Parent
function public
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls Vcl.Controls

Description

Translates a predefined cursor constant into a cursor.

Call IdentToCursor to reverse the translation performed by the CursorToIdent function. This method is useful for converting the strings generated by GetCursorValues into useable cursors. IdentToCursor returns true if the Ident parameter is successfully converted into a cursor. IdentToCursor returns false if the Ident parameter is not the name of one of the built-in cursor constants.

Note: If the string identifier for a cursor may represent either a numeric value or a cursor constant, use the StringToCursor function instead.

See Also