Home
Business Logic / Control
Endless possibilities in data processing for your projects.
CONTROL Functions
Functions O
OPCEnumQuery()
Function for browsing registered OPC servers. This function is used for the simple OPC client configuration.

Version Information
Release Notes, Update information, Certifications and Frequently Asked Questions.
Concepts
Your first step into modern and powerful process visualization.
Deployment
Topics you need to know before using WinCC OA.
Security
Go beyond the norm in cybersecurity.
Engineering
Powerful tools for easy or complex engineering tasks.
Data Management
Classify, structure and archive your data.
Business Logic / Control
Endless possibilities in data processing for your projects.
- Introduction to CTRL
  An introduction to the product's own programming language Control(CTRL).
- Control Classes
  The overview of classes available in Control.
- Types of Control Functions
  An overview of the types of functions distinguished within Control.
- Control graphics
- CONTROL Functions
  - Functions A
  - Functions B
  - Functions C
  - Functions D
  - Functions E
  - Functions F
  - Functions G
  - Functions H
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
    - onBoard()
      The method checks whether an asset is valid (onboarding). The method connects to MindSphere.
    - OPCEnumQuery()
      Function for browsing registered OPC servers. This function is used for the simple OPC client configuration.
    - openAES()
      Opens the alert and event panel at the desired position and allows executing an action such as print the upper table of the alert and event panel or save the table.
    - openDialog()
      Opens a dialog for simple configuration.
    - openHelpViewer()
      The function opens the Help Viewer.
    - openLogViewer()
      Opens the Log Viewer.
    - openProgressBar()
      Displays a module with the defined parameters for a progress bar.
    - openTrend()
      Opens a predefined trend group.
    - openTrendCurves()
      Opens a trend with a configuration trendName and replaces the curves that contain a dollar parameter.
    - openUrl()
      The function openUrl is used to open files located at arbitrary URLs in external applications.
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CtrlExtension
  The CtrlExtension allows the addition of custom C++ code.
- CTRL Debugger
  You can use the CTRL debugger to debug the Control programming language. The debugger can be used via its own panel, which also enables the monitoring and setting of variable values during the execution of a script.
- SQL in CONTROL
  The database functions enable you to quickly carry out value queries on data points and elements.
- WinCC OA JavaScript Manager for Node.js
  The WinCC OA JavaScript Manager for Node.js is a manager that allows for the integration of the TypeScript/JavaScript runtime environment Node.js® into WinCC OA.
- API Manager
  The WinCC OA API (Application Programming Interface) offers a number of functions adding special Managers to this process control system.
Data Visualization
User interfaces, Trends and Reports for every purpose and device.
Southbound Interfaces
The process connection to the actual machines/sensors.
Northbound Interfaces
Your portal to the cloud or supervising systems.
Web Connectivity / Network Interfaces
Data exchange, APIs and web technologies
User Management
All about authorization, authentication and login-customization.
Availability
How to get your system uptime to the maximum.
Reporting
Create state of the art project reports without limits.
Addons
Useful tools and enhancements for special demands.
Reference Tables
Detailed and extensive content for special project adaptation.
Videos & Tutorials
Explore the capabilities of WinCC OA with our carefully selected collection of video tutorials and guides.
Documentation
Basic information about terms and functions within the documentation.
Support & Services
An experienced team of support agents, consultants and trainers are ready to facilitate active partnerships with our customers, so they can profit from our comprehensive service.
Disclaimer
A brief clarification of liability exclusions or legal notices.

OPCEnumQuery()

Function for browsing registered OPC servers. This function is used for the simple OPC client configuration.

Synopsis

int OPCEnumQuery(int type, dyn_string in, dyn_string &out);

Parameters


Parameter	Description
type	1 = Search for OPC servers. 2 = Search for OPCA&E-Servers.
in	The host name. For searching registered OPC servers. Specifying an empty string "" will search the own host.
out	List of found servers

Return value

If the operation has been successful, the function returns 1 otherwise, an error occurred.

Error

Description

This function searches for registered OPC servers on a specified host name. The simple OPC client configuration uses this function. For the search you can only specify one host name.

Example

The following example returns a list of installed OPC servers on the host "eiwnt160".

main()
{
  int t = 2;
  int retVal;
  dyn_string i = " eiwnt160 ";
  dyn_string o;
  retVal = OPCEnumQuery(t,i,o);
  DebugN("Return value: ",retVal,"Type: ",t,"In; ",i,"OPC A&E
  servers: ",o);
}

Assignment

Miscellaneous functions

Availability

CTRL