Developer Reference

Contents

DftiFreeDescriptorDM

Frees memory allocated for a descriptor.

Syntax

status
=
DftiFreeDescriptorDM
(
&handle
)
;
Include Files
  • mkl_cdft.h
Input Parameters
handle
The descriptor handle. Must be valid, that is, created in a call to
DftiCreateDescriptorDM
.
Output Parameters
handle
The descriptor handle. Memory allocated for the handle is released on output.
Description
This function frees up all memory allocated for a descriptor in a particular MPI process. Call the
DftiFreeDescriptorDM
function to delete the descriptor handle. Upon successful completion of
DftiFreeDescriptorDM
the descriptor handle is no longer valid.
Return Values
The function returns
DFTI_NO_ERROR
when completes successfully. If the function fails, it returns a value of another error class constant (for the list of constants, refer to Error Codes).
Prototype
    MKL_LONG DftiFreeDescriptorDM(DFTI_DESCRIPTOR_DM_HANDLE *handle);    

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.