CM_REMOVERECORD - Parameters

pRecordArray (PVOID)

Pointer to an array of pointers to RECORDCORE structures that are to be removed.

cNumRecord (USHORT)

Number of records.

Number of container records to be removed. If the cNumRecord parameter has a value of 0, all of the records in the container are removed and the pRecordArray parameter is ignored.

fRemoveRecord (USHORT)

Flags.

Flags that show whether memory must be freed and container records invalidated.

CMA_FREE

If specified, RECORDCORE structures are removed and memory associated with the RECORDCORE structures is freed. If not specified, RECORDCORE structures are removed and no memory is freed; this is the default.
CMA_INVALIDATE
If specified, after RECORDCORE structures are removed the container is invalidated and any necessary repositioning of the container records is performed. If not specified, invalidation is not performed.

This option is not valid in the icon view unless the CCS_AUTOPOSITION style bit is not set. In the icon view, the container record is refreshed if the CCS_AUTOPOSITION style bit is set. regardless of whether the CMA_INVALIDATE attribute is set.

cRecords (LONG)

Number of structures.
• An error occurred. The WinGetLastError function may return the following errors:

  • PMERR_INVALID_PARAMETERS 
    PMERR_MEMORY_DEALLOCATION_ERR.
    Other
    Number of root level RECORDCORE structures that remain in the container.

    ---

    [Back: CM_REMOVERECORD Return Value - cRecords]
    [Next: CM_REMOVERECORD - Syntax]