CNVNewVariableCollection

int CNVNewVariableCollection (const char *parentPath, size_t numberOfVariables, const char * variableNames[], unsigned int maxBufferItems, int singleWriter);

Purpose

Creates variables in the network variable path you specify. If you specify a variableName that already exists, CNVNewVariableCollection overwrites the existing variables.

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.

Note Note  National Instruments recommends that you use only alphanumeric characters in process, folder, and variable names. If the name contains single quotation mark ('), backslash (\), period (.), newline (\n), or carriage return (\r) characters, you must escape these characters by enclosing the name in single quotation marks. If the contains single quotation mark characters, you also must precede that character with another single quotation mark.

For example, to specify process'Name\folder.Name as a path, enter the following:

  • 'process''Name' as the process name
  • 'folder.Name' as the folder name

Thus, the value you specify for parentPath is 'process''Name\'folder.Name'.

numberOfVariables size_t The number of variables to create.
variableNames const char *[] The names of the variables to create.

Note Note  National Instruments recommends using only alpha-numeric characters in variable names.
maxBufferItems unsigned int The maximum number of items to buffer on the server for each of the variables.
singleWriter int Specify whether the variables must have the single-writer restriction.

Specify a nonzero value or select Yes in the function panel if the variables must have the single-writer restriction.

Specify 0 or select No in the function panel otherwise.

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

WAS THIS ARTICLE HELPFUL?

Not Helpful