ToneFree

Frees memory allocated by the function ippsToneInitAllocQ15.

Syntax

IppStatus ippsToneFree(IppToneState_16s* pToneState);

Parameters

pToneState

Pointer to the tone generator specification structure.

Description

The function ippsToneFree is declared in the ipps.h file. This function closes the tone generator state by freeing all memory associated with the structure created by ippsToneInitAllocQ15.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error when the pointer pToneState is NULL.