LabVIEW OPC UA Toolkit API Reference

Content Type
Programming Language
Current manual

Add Folder VI

Add Folder VI

Owning Palette: OPC UA Server VIs

Requires: OPC UA Toolkit

Creates a folder under the parent folder in the address space.

After you start an OPC UA server, you cannot add folders until the OPC UA server stops. Use the Stop VI to stop an OPC UA server.

Example

OPC UA server refnum in specifies the reference data value of the OPC UA server.
parent folder node ID specifies the ID of the parent folder. The format of the node ID is ns=<namespace index>;<identifier type>=<identifier>. If the parent folder does not exist, this VI creates a folder at the root level. A node ID contains the following components:
  • namespace index is a base 10 number that indicates the namespace of the node ID.
    If namespace index is 0, the format of the node ID can be <identifier type>=<identifier>. The namespace index for a node that you created with the OPC UA Toolkit is 2.
  • identifier type represents the type of the identifier and has the following values:

    ValueIdentifier Type
    iNumeric
    sString
    gGUID
    bOpaque
  • identifier is a string value that represents the name of the identifier.


The format of the node ID can also be ns=<namespace index>;<identifier type>=<identifier>@<index>:<index>. For example, ns=2;s=Folder.Array@1:2. This format only applies to the array data type and allows you to read a single element or a range of elements of an array. You cannot use @ in a node name.

For backwards compatibility, parent folder node ID also accepts node paths as input for OPC UA servers only. You can regard the node path as the string type identifier of the node ID. For example, a node path can be Device.folder.item.
folder name specifies the name of the folder to create. If a folder with the same name already exists in the parent folder, this VI returns an error.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
description specifies additional information about the folder.
OPC UA server refnum out returns the reference data value of the OPC UA server.
folder node ID returns the ID of the new folder that this VI creates.
error out contains error information. This output provides standard error out functionality.

Example

Refer to the OPC UA Demo.lvproj in the labview\examples\Data Communication\OPCUA directory for an example of using the Add Folder VI.

In This Section
Was this information helpful?