CM QUERYGRIDINFO: Difference between revisions
Created page with "This message queries the current characteristics of the grid. ==Syntax== <PRE> param1 PGRIDINFO pGridInfo; →Pointer to a GRIDINFO structure.: param2 ULONG ulReserved; →This value is NULL.: </PRE> ==Parameters== ;pGridInfo (PGRIDINFO) - Input/Output : Pointer to a GRIDINFO structure. ;ulReserved (ULONG) - Input : This value is NULL. ==Returns== ;rc (BOOL) - returns : Success indicator. ::TRUE: The GRIDINFO structure has been updated with th..." |
|||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
;pGridInfo ([[ | ;pGridInfo (P[[GRIDINFO]]) - Input/Output | ||
: Pointer to a [[GRIDINFO]] structure. | : Pointer to a [[GRIDINFO]] structure. | ||
;ulReserved ([[ULONG]]) - Input | ;ulReserved ([[ULONG]]) - Input | ||
Latest revision as of 22:36, 20 April 2025
This message queries the current characteristics of the grid.
Syntax
param1 PGRIDINFO pGridInfo; /* Pointer to a GRIDINFO structure. */ param2 ULONG ulReserved; /* This value is NULL. */
Parameters
- pGridInfo (PGRIDINFO) - Input/Output
- Pointer to a GRIDINFO structure.
- ulReserved (ULONG) - Input
- This value is NULL.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE: The GRIDINFO structure has been updated with the grid information.
- FALSE: An error has occurred.
Remarks
The cb and pGrid fields can be set by the application with CM_SETGRIDINFO before sending this message.
If pGrid is NULL, the fields cxGrid, cyGrid, sGridRows, sGridCols, and cGridSquares are updated by the container.
If pGrid is non-NULL, the container expects it to point to an array of GRIDSQUARE structures whose size is equal to cGridSquares*sizeof(GRIDSQUARE). The container will copy its internal grid square information into the GRIDINFO structure passed by the application.
Default Processing
The default window procedure does not expect to receive this message and therefore takes no action on it other than to return FALSE.