ldmp_freeparms Kernel Service

Purpose

Frees any data allocated by the live dump associated with an unused ldmp_parms_t data item.

Syntax

#include <sys/livedump.h>

kerrno_t ldmp_freeparms (parms)
ldmp_parms_t *parms;

Parameters

Item Description
parms Points to an item of ldmp_parms_t type.

Description

The ldmp_freeparms kernel service is used in the event that you have partially set up the ldmp_parms_t data item, but do not want to take a dump. You can use the ldmp_freeparms kernel service to clean up any data allocated by the live dump subsystem. However, you can always call the ldmp_freeparms kernel service after the livedump kernel service, and the ldmp_freeparms kernel service returns normally if there is nothing to free.

Execution Environment

The ldmp_freeparms kernel service can be called from either the process or interrupt environment.

Return Values

Item Description
0 Indicates a successful completion.
EINVAL_RAS_LDMP_FREEPARMS Indicates that the area is not a valid ldmp_parms_t data area.
EFAULT_RAS_LDMP_FREEPARMS Indicates that a memory fault results.