writeFmt IN ViString The format string to apply to parameters in ViVAList. params IN ViVAList A list containing the variable number of parameters on which the format string is applied. The formatted data is written to the specified device. Return Values This is the operational return status. It returns either a Type ViStatus completion code or an error code as follows. Completion Code Description VI_SUCCESS Parameters were successfully formatted. Error Codes Description VI_ERROR_INV_SESSION The given session or object reference is invalid (both VI_ERROR_INV_OBJECT are the same value). VI_ERROR_RSRC_LOCKED Specified operation could not be performed because the resource identified by has been locked for this vi kind of access. VI_ERROR_INV_FMT A format specifier in the string is invalid. writeFmt VI_ERROR_NSUP_FMT A format specifier in the string is not writeFmt supported. VI_ERROR_ALLOC The system could not allocate a formatted I/O buffer because of insufficient system resources. Description This operation is similar to except that the output is not written to the device; it is written to viVPrintf(), the user-specified buffer. This output buffer will be NULL terminated. Related Items See the INSTR resource description. Also see and viSPrintf() viVPrintf(). Implementation Requirements RULE 6.2.9 IF the operations outputs an END indicator before all the arguments are satisfied, THEN viVSPrintf() the rest of the string SHALL be ignored and the buffer string will still be terminated by a writeFmt NULL. 6.2.7 viBufWrite(vi, buf, count, retCount) Purpose Similar to except the data is written to the formatted I/O write viWrite(), buffer rather than directly to the device. Parameters Name Direction Type Description
writeFmt IN ViString The format string to apply to parameters in ViVAList. params IN ViVAList A list containing the variable number of parameters on which the format string is applied. The formatted data is written to the specified device. Return Values Type ViStatus This is the operational return status. It returns either a completion code or an error code as follows. Completion Code Description VI_SUCCESS Parameters were successfully formatted. Error Codes Description VI_ERROR_INV_SESSION VI_ERROR_INV_OBJECT The given session or object reference is invalid (both are the same value). VI_ERROR_RSRC_LOCKED Specified operation could not be performed because the resource identified by vi has been locked for this kind of access. VI_ERROR_INV_FMT A format specifier in the writeFmt string is invalid. VI_ERROR_NSUP_FMT A format specifier in the writeFmt string is not supported. VI_ERROR_ALLOC The system could not allocate a formatted I/O buffer because of insufficient system resources. Description This operation is similar to viVPrintf(), except that the output is not written to the device; it is written to the user-specified buffer. This output buffer will be NULL terminated. Related Items See the INSTR resource description. Also see viSPrintf() and viVPrintf(). Implementation Requirements RULE 6.2.9 IF the viVSPrintf() operations outputs an END indicator before all the arguments are satisfied, THEN the rest of the writeFmt string SHALL be ignored and the buffer string will still be terminated by a NULL. 6.2.7 viBufWrite(vi, buf, count, retCount) Purpose Similar to viWrite(), except the data is written to the formatted I/O write buffer rather than directly to the device. Parameters Name Direction Type Description
vpp43_2016-02-26.docx