IviUpconverter_GetIFInputName
- Updated2023-02-24
- 2 minute(s) read
ViStatus IviUpconverter_GetIFInputName (ViSession instrumentHandle, ViInt32 index, ViInt32 nameBufferSize, ViChar _VI_FAR name[]);
Purpose
This function returns the specific driver defined IF input name that corresponds to the one-based index that you specify. If the driver defines a qualified IF input name, this function returns the qualified name. If the specified value for the index parameter is less than one or greater than the value of the IVIUPCONVERTER_ATTR_IF_INPUT_COUNT attribute, the function returns an empty string in the name parameter and returns the Invalid Value error.
Parameters
| Input | ||
| Name | Type | Description |
|---|---|---|
| instrumentHandle | ViSession | The ViSession handle that you obtain from the IviUpconverter_init or IviUpconverter_InitWithOptions function. The handle identifies a particular instrument session.
Default Value: None |
| index | ViInt32 | Specifies the one-based index of the IF input name to return.
Default Value: 1 |
| nameBufferSize | ViInt32 | Specifies the buffer size for the name parameter.
Default Value: 0 |
| Output | ||
| Name | Type | Description |
| name | ViChar[] | Returns the IF input name that corresponds to the index.
The name buffer must contain at least as many elements as the value you specify with the nameBufferSize parameter. |
Return Value
| Name | Type | Description |
|---|---|---|
| status_orRequiredSize | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You examine the status code from each call to an instrument driver function to determine if an error occurred.
To obtain a text description of the status code, or if the status code is not listed below, call the IviUpconverter_error_message function. To obtain additional information about the error condition, call the IviUpconverter_GetError function. To clear the error information from the driver, call the IviUpconverter_ClearError function. The general meaning of the status code is as follows: Value Meaning ------------------------------- 0 Success Positive Values Warnings Negative Values Errors This driver defines the following status codes: Status Description ------------------------------------------------- WARNINGS: No defined warnings. ERRORS: BFFA1001 Trigger source is not set to software trigger. BFFA2001 Max Time Exceeded. BFFA2002 List Unknown. This instrument driver returns errors and warnings defined by other sources. The following table defines the ranges of additional status codes that this driver can return. The table lists the different include files that contain the defined constants for the particular status codes: Numeric Range (in Hex) Status Code Types ------------------------------------------------- 3FFA0000 to 3FFA1FFF IVI Warnings 3FFF0000 to 3FFFFFFF VISA Warnings 3FFC0000 to 3FFCFFFF VXIPnP Driver Warnings BFFA0000 to BFFA1FFF IVI Errors BFFF0000 to BFFFFFFF VISA Errors BFFC0000 to BFFCFFFF VXIPnP Driver Errors |
References