Vcl.Controls.CursorToIdent
Delphi
function CursorToIdent(Cursor: Longint; var Ident: string): Boolean;
C++
extern DELPHI_PACKAGE bool __fastcall CursorToIdent(int Cursor, System::UnicodeString &Ident);
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Vcl.Controls.pas Vcl.Controls.hpp |
Vcl.Controls | Vcl.Controls |
Description
Returns the name of the predefined constant that corresponds to a cursor.
Use CursorToIdent to convert the cursor used by a control or one of the cursors made available by the global screen variable into the name of the corresponding constant. Pass the cursor value as the Cursor parameter. CursorToIdent returns the constant name as the Ident parameter. If the cursor does not have an associated constant (for example, a custom cursor), CursorToIdent returns false.
To obtain a string representation of the cursor, even if there is no built-in cursor constant for it, use the CursorToString function.
CursorToIdent can be used to identify the current cursor in a list of possible cursor constants that is built using GetCursorValues.