Jump to content

CM ERASERECORD

From EDM2
Revision as of 21:56, 20 April 2025 by Martini (talk | contribs) (Parameters)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This message erases the source record from the current view when a move occurs as a result of direct manipulation. 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.

Syntax

param1
PRECORDCORE pRecord;   /* Pointer to the container record that is to be erased from the current view. */

param2
ULONG ulReserved;    /* Reserved value, should be 0. */

Parameters

pRecord (PRECORDCORE) - Input
Pointer to the container record that is to be erased from the current view.
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.
ulReserved (ULONG) - Input
Reserved value, should be 0.

Returns

rc (BOOL) - returns
Success indicator.
TRUE: The record was successfully erased.
FALSE: The record was not erased. The WinGetLastError function may return the following errors:
PMERR_INVALID_PARAMETERS
PMERR_INSUFFICIENT_MEMORY.

Remarks

The container record is not removed and memory is not freed; only the visual appearance is changed. The visibility flag associated with the container record is not changed.

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.