Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

DftiGetValue

Gets the configuration value of one particular configuration parameter.

Syntax

status = DftiGetValue(desc_handle, config_param, &config_val);

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

desc_handle

DFTI_DESCRIPTOR_HANDLE

FFT descriptor.

config_param

enum

Configuration parameter. See Table "Configuration Parameters" for allowable values of config_param.

Output Parameters

Name

Type

Description

config_val

Depends on the configuration parameter.

Configuration value.

status

MKL_LONG

Function completion status.

Description

This function gets the configuration value of one particular configuration parameter. Each configuration parameter is a named constant, and the configuration value must have the corresponding type, which can be a named constant or a native type. For available configuration parameters and the corresponding configuration values, see:

The function returns zero when it completes successfully. See Status Checking Functions for more information on the returned status.

Prototype

 
				MKL_LONG DftiGetValue( DFTI_DESCRIPTOR_HANDLE,
      DFTI_CONFIG_PARAM ,
      ... );
 
Related information
Configuration Settings for more information on configuration parameters.