RFmxDemod_GetError

RFmx Demod 19.1 Help

Edition Date: October 2019

Part Number: 374641M-01

»View Product Info

Download Help (Windows Only)


RFmx Demod 19.1 Help
RFmx Demod 20.0 Help
RFmx Demod 20.6 Help

int32 __stdcall RFmxDemod_GetError (niRFmxInstrHandle instrumentHandle, int32* errorCode, int32 errorDescriptionBufferSize, char errorDescription[]);

Purpose

Retrieves and then clears the error information for the session or the current execution thread. You must provide a char array to serve as a buffer for the value. Pass the number of bytes in the buffer as the errorDescriptionBufferSize parameter.

If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the errorDescriptionBufferSize parameter, the function copies (buffer size - 1) bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is , if the value is 123456 and the buffer size is 4, the function places 123 into the buffer and returns 7.

If you want to call this function just to get the required buffer size, you can pass 0 for errorDescriptionBufferSize and NULL for the errorDescription parameter.

Note  Use the RFmxDemod_GetErrorString function if the RFmxDemod_GetError function does not return an error message.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the RFmx session. If a valid session handle is passed, the last error stored in that session is retrieved. You can pass NULL, to retrieve the last error stored in the current execution thread.
errorDescriptionBufferSize int32

Passes the number of bytes in the char array you specify in errorDescription.

If the error description, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function copies errorDescriptionBufferSize – 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the size of the buffer that you must pass to get the entire value. For example, if the value is "123456" and the buffer size is 4, the function places "123" into the buffer and returns 7.

Output
Name Type Description
errorCode int32*

Returns the error code for the session or execution thread. If you pass 0 for the errorDescriptionBufferSize parameter, you can pass NULL for the errorCode parameter.

errorDescription char[]

Returns the error description for the session or execution thread. If there is no description, this function returns an empty string.

The buffer must contain at least as many elements as the value you specify with the errorDescriptionBufferSize parameter.

Return Value

Name Type Description
statusOrRequiredSize int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful