CNVGetVariableAttribute
int CNVGetVariableAttribute (const char *parentPath, const char *variableName, CNVVariableAttribute attribute, void *value);
Purpose
Obtains the value of a network variable attribute.
Parameters
| Input | ||||
| Name | Type | Description | ||
| parentPath | const char * | The parent's machine-relative path. You can specify a process name or a process name followed by one or more folder names delimited with the backslash path separator. Do not include a trailing backslash in the path.
|
||
| variableName | const char * | The name of the network variable.
|
||
| attribute | CNVVariableAttribute | The network variable attribute value to obtain. | ||
| Output | ||||
| Name | Type | Description | ||
| value | void * | The value of the specified network variable attribute. The data type for this parameter depends on the data type of the attribute you specify for the attribute parameter. Pass the address of a variable of the same data type of the attribute you pass to attribute. |
||
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.5 and later
Example
Refer to networkvariable\Configurator\configurator.cws for an example of using the CNVGetVariableAttribute function.