CM SEARCHSTRING: Difference between revisions
Created page with "This message returns the pointer to a container record whose text matches the string. ==Syntax== <PRE> param1 PSEARCHSTRING pSearchString; →Pointer to the SEARCHSTRING structure.: param2 PRECORDCORE pSearchAfter; →Pointer to the starting container record.: </PRE> ;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 PRE..." |
No edit summary |
||
| Line 10: | Line 10: | ||
;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. | ;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. | ||
==Parameters== | ==Parameters== | ||
;pSearchString ([[ | ;pSearchString (P[[SEARCHSTRING]]) - Input | ||
: Pointer to the [[SEARCHSTRING]] structure. | : Pointer to the [[SEARCHSTRING]] structure. | ||
;pSearchAfter ([[ | ;pSearchAfter (P[[RECORDCORE]]) - Input | ||
: Pointer to the starting container record. | : Pointer to the starting container record. | ||
::CMA_FIRST: Start the search at the first container record. | ::CMA_FIRST: Start the search at the first container record. | ||
| Line 18: | Line 18: | ||
==Returns== | ==Returns== | ||
;pRecord ([[ | ;pRecord (P[[RECORDCORE]]) - returns | ||
: Pointer to the found container record. | : Pointer to the found container record. | ||
::NULL: No container record's text matches the search string. | ::NULL: No container record's text matches the search string. | ||
| Line 26: | Line 26: | ||
==Remarks== | ==Remarks== | ||
The CM_SEARCHSTRING message is NLS-enabled. | The [[CM_SEARCHSTRING]] message is NLS-enabled. | ||
In the details view, the string is searched for in each column of each record. | In the details view, the string is searched for in each column of each record. | ||
Latest revision as of 01:22, 21 April 2025
This message returns the pointer to a container record whose text matches the string.
Syntax
param1 PSEARCHSTRING pSearchString; /* Pointer to the SEARCHSTRING structure. */ param2 PRECORDCORE pSearchAfter; /* Pointer to the starting container record. */
- 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.
Parameters
- pSearchString (PSEARCHSTRING) - Input
- Pointer to the SEARCHSTRING structure.
- pSearchAfter (PRECORDCORE) - Input
- Pointer to the starting container record.
- CMA_FIRST: Start the search at the first container record.
- Other: Start the search after the container record specified by this pointer. To get all of the records in the container whose text matches the string, this message is sent repeatedly. Each time this message is sent, the pSearchAfter parameter contains a pointer to the last record that was found.
Returns
- pRecord (PRECORDCORE) - returns
- Pointer to the found container record.
- NULL: No container record's text matches the search string.
- -1: An error occurred. The WinGetLastError function may return the following error:
- PMERR_INVALID_PARAMETERS.
- Other: Pointer to the container record whose text matches the search string.
Remarks
The CM_SEARCHSTRING message is NLS-enabled.
In the details view, the string is searched for in each column of each record.
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.