Intel® Integrated Performance Primitives Developer Guide and Reference

ID 790148
Date 11/07/2023
Public

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

Document Table of Contents

GetStatusString

Translates a status code into a message.

Syntax

const char* ippGetStatusString(IppStatus stsCode);

Include Files

ippcore.h

Parameters

stsCode

Code that indicates the status type (see Error Status Values and Messages).

Description

This function returns a pointer to the text string associated with a status code of IppStatus type . Use this function to produce error and warning messages for users. The returned pointer is a pointer to an internal static buffer and does not need to be released.

Example

The following code example shows how to use the function ippGetStatusString. If you call an Intel IPP function ippsAddC_16s_I with a NULL pointer, it returns an error code -8. The status information function translates this code into the corresponding message "Null Pointer Error".

void statusinfo(void) {
       IppStatus st = ippsAddC_16s_I (3, 0, 0);
       printf("%d : %s\n", st, ippGetStatusString(st)); 
}    

Output:

-8, Null Pointer Error