CM FREEDETAILFIELDINFO

This message frees the memory associated with one or more FIELDINFO structures.

Syntax

param1
PVOID pFieldInfoArray; /* Pointer to an array of pointers to FIELDINFO structures that are to be freed. */

param2
USHORT cNumFieldInfo;  /* Number of structures. */

Parameters

pFieldInfoArray (PVOID) - Input

Pointer to an array of pointers to FIELDINFO structures that are to be freed.

cNumFieldInfo (USHORT) - Input

Number of FIELDINFO structures to be freed.

Returns

rc (BOOL) - returns

Success indicator.

TRUE: Memory associated with a specified FIELDINFO structure or structures in the container was freed.

FALSE: Associated memory was not freed. The WinGetLastError function may return the following errors:

PMERR_INVALID_PARAMETERS

PMERR_MEMORY_DEALLOCATION_ERR

PMERR_FI_CURRENTLY_INSERTED.

Remarks

It is the application's responsibility to free all application-allocated memory associated with the structures, such as user data.

If a specified FIELDINFO structure is currently inserted into the container, the structure is not freed and the PMERR_FI_CURRENTLY_INSERTED error is set. FIELDINFO structures must be removed with the CM_REMOVEDETAILFIELDINFO message before the CM_FREEDETAILFIELDINFO message is used.

If the number of pointers to FIELDINFO structures in the array exceeds the count of structures to be freed, only the number of structures in the cNumFieldInfo parameter is freed. If either the pFieldInfoArray or the cNumFieldInfo parameter is invalid, the PMERR_INVALID_PARAMETERS error is set and no FIELDINFO structures are freed.

If the PMERR_MEMORY_DEALLOCATION_ERR error occurs, any further processing is unreliable.

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.