niDCPower_GetNextCoercionRecord
ViStatus niDCPower_GetNextCoercionRecord (ViSession vi, ViInt32 bufferSize, ViChar coercionRecord[]);
Purpose
Returns the coercion information associated with the IVI session and clears the earliest instance in which NI-DCPower coerced a value you specified.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies a particular instrument session. vi is obtained from the niDCPower_init or niDCPower_InitWithOptions function. |
| bufferSize | ViInt32 | Specifies the number of bytes in the ViChar array you specify for coercionRecord. If the next coercion record string, including the terminating NUL byte, contains more bytes than you indicate in this attribute, the function copies (buffer size - 1) bytes into the buffer, places an ASCII NUL 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 123456 and the buffer size is 4, the function places 123 into the buffer and returns 7. If you pass a negative number, the function copies the value to the buffer regardless of the number of bytes in the value. If you pass 0, you can pass VI_NULL for coercionRecord. |
| Output | ||
| Name | Type | Description |
| coercionRecord | ViChar[] | Returns the next coercionRecord for the IVI session. If there are no coercionRecords, the function returns an empty string. |
Return Value
| Name | Type | Description |
| Status | ViStatus |
Reports the status of this operation. To obtain a text description of the status code, call niDCPower_error_message. To obtain additional information concerning the error condition, call niDCPower_GetError. |