CNVGetDataQualityDescription

int CNVGetDataQualityDescription (CNVDataQuality quality, const char *delimiter, char **description);

Purpose

Gets the textual description of the quality of the data.

Parameters

Input
Name Type Description
quality CNVDataQuality The quality of data. The quality value can be one of the following values or a bitwise OR-ed combination of two or more of the following values. The quality value is zero if you do not set any of the following bits.

CNVDataQualityGood0
CNVDataQualityStale1 << 0
CNVDataQualitySensorFailure1 << 1
CNVDataQualityDeviceFailure1 << 2
CNVDataQualityServerFailure1 << 3
CNVDataQualityNetworkFailure1 << 4
CNVDataQualityNonexistent1 << 5
CNVDataQualityNoKnownValue1 << 6
CNVDataQualityInactive1 << 7
CNVDataQualityForced1 << 8
CNVDataQualityLowLimited1 << 9
CNVDataQualityHighLimited1 << 10
CNVDataQualityConstant1 << 11
CNVDataQualitySensorInaccurate1 << 12
CNVDataQualityEULimitsExceeded1 << 13
CNVDataQualitySubnormal1 << 14
CNVDataQualityMathException1 << 15
CNVDataQualityCommLinkFailure1 << 16
CNVDataQualityConnecting1 << 17
CNVDataQualityDNSFailure1 << 18
CNVDataQualityHostUnreachable1 << 19
CNVDataQualityServiceLookupFailure1 << 20
CNVDataQualityDisconnected1 << 21
CNVDataQualityProcessFailure1 << 22
CNVDataQualityResolveURLFailure1 << 23
CNVDataQualityAccessDenied1 << 24
CNVDataQualityInvalidURL1 << 25
CNVDataQualityAppDefined11 << 26
CNVDataQualityAppDefined21 << 27
CNVDataQualityAppDefined31 << 28
CNVDataQualityInAlarm1 << 29
CNVDataQualitySubscribeFailed1 << 30
CNVDataQualityExtendedInfo1 << 31
CNVDataQualityReadBufferFull(1 << 0) << 32
CNVDataQualityReadBufferOverflow(1 << 1) << 32
CNVDataQualityServerWriteBufferFull(1 << 2) << 32
CNVDataQualityServerWriteBufferBufferOverflow(1 << 3) << 32
delimiter const char * The string to use as the delimiter between different quality fields. If you pass NULL or an empty string, the Network Variable Library uses a semicolon as the default delimiter.
Output
Name Type Description
description char * The description of the specified quality. You must free this string using CNVFreeMemory.

Return Value

Name Type Description
status int Return value indicating whether the function was successful. One indicates that a next item was found, zero indicates that a next item was not found, and a negative number indicates that an error occurred.

You can call CNVGetErrorDescription to obtain a string that describes the error.

Additional Information

Library: Network Variable Library

Include file: cvinetv.h

LabWindows/CVI compatibility: LabWindows/CVI 8.1 and later

Example

Refer to networkvariable\Quality\NVQuality.cws for an example of using the CNVGetDataQualityDescription function.

Open example

WAS THIS ARTICLE HELPFUL?

Not Helpful