CM QUERYRECORDFROMRECT

This message queries for a container record that is bounded by the specified rectangle.

Syntax

param1
PRECORDCORE pSearchAfter;    /* Pointer to the specified container record. */

param2
PQUERYRECFROMRECT pQueryRecFromRect; /* Pointer to the QUERYRECFROMRECT data structure. */

Note

; If the CCS_MINIRECORDCORE style bit is specified when a container is created, then MINIRECORDCORE should be used instead of RECORDCORE, and PMINIRECORDCORE should be used instead of PRECORDCORE in all applicable data structures and messages. The values of this parameter can be:

Parameters

pSearchAfter (PRECORDCORE) - Input

Pointer to the specified container record. To get all the container records within the specified rectangle, this message is sent repeatedly, each time this parameter is set to the pointer that is returned by the previous usage of this message. The values of this parameter can be:

CMA_FIRST: Start the search with the first record in the container.

Other: Start the search after the record specified by this pointer.

pQueryRecFromRect (PQUERYRECFROMRECT) - Input

Pointer to the QUERYRECFROMRECT data structure.

Returns

pRecord (PRECORDCORE) - returns

Pointer to the container records within the bounding rectangle.

NULL: No container records are within the bounding rectangle.

-1: The container record data was not returned. The WinGetLastError function may return the following error:

PMERR_INVALID_PARAMETERS.

Other: Pointer to the container record within the bounding rectangle.

Remarks

This message returns the pointer to the first container record found in the rectangle after the starting position specified in the pSearchAfter parameter.

Default Processing

The default window procedure does not expect to receive this message and therefore takes no action on it other than to return NULL.