| |
| BOOL GetCell( |
| |
INT xPos, |
|
| |
INT yPos |
|
| |
TCHAR* pChar |
|
| |
UINT* pAttributes |
|
| ); |
| BOOL GetCell( |
| |
TCHAR* pChar |
|
| |
UINT* pAttributes |
|
| ); |
The GetCell method returns information about the specified
character cell in the virtual display.
Parameters
- xPos
- An integer value which specifies the X cursor position in the
display. If this argument is omitted or has the value -1, then the
current position in the display is used.
- yPos
- An integer value which specifies the Y cursor position in the
display. If this argument is omitted or has the value -1, then the
current position in the display is used.
- pChar
- A pointer to a buffer that will contain the character in the
specified cell when the method returns. If this argument is NULL,
then no character is returned.
- pAttributes
- A pointer to an unsigned integer value which specifies the
attributes for the specified character cell. If this argument is
NULL, then no attribute information is returned.
Return Value
If the method succeeds, the return value is non-zero. If the
method fails, it returns zero. Failure typically indicates that the X
or Y position is invalid, or that a virtual display has not been
created.
Remarks
The attribute value returned by the GetCell method may be
one or more of the following values:
| Constant |
Description |
| NVT_ATTRIBUTE_NORMAL |
Normal, default attributes. |
| NVT_ATTRIBUTE_REVERSE |
Foreground and background cell colors are reversed. |
| NVT_ATTRIBUTE_BOLD |
The character is displayed using a higher intensity
color. |
| NVT_ATTRIBUTE_DIM |
The character is displayed using a lower intensity
color. |
| NVT_ATTRIBUTE_UNDERLINE |
The character is displayed with an underline. |
| NVT_ATTRIBUTE_HIDDEN |
The character is stored in display memory, but not
shown. |
| NVT_ATTRIBUTE_PROTECT |
The character is protected and cannot be cleared. |
One or more attributes may be combined using a bitwise Or
operator. Certain attributes, such as NVT_ATTRIBUTE_BOLD and
NVT_ATTRIBUTE_DIM are mutually exclusive.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csnvtv10.lib
See Also
GetAttributes,
GetCellSize,
SetAttributes
|
|