qualifyName

qualifyName — creates a point name string qualified by a domain name.

Syntax

For C++:

static CString qualifyName(LPCTSTR  domainname,
 LPCTSTR  pointname);

For Java and C#:

static String qualifyName(String  domainname,
 String  pointname);

Parameters

pointname

The name of the point.

domainname

The name of the domain containing the point.

Returns

A string with the correctly formatted qualified point name.

Description

This utility method is used to add the domain name qualifier to a point name, using the format domainname:pointname. If the point name is already qualified, then the domain name is replaced with the new domainname specified.

[Note]

If setDefaultDomain is used, and the point belongs to that domain, then it is not necessary to qualify the point. A qualified point name is normally used to reference points from domains other than the application's default domain.

Examples

All of these would reference the same point:

    writePoint(_T("domain1:point1")), 1);
    writePoint(CDataHubPoint::qualifyName(_T("domain1"),_T("point1")), 1);
    setDefaultDomain(_T("domain1"));
    writePoint(_T("point1"), 1);

See Also

setDefaultDomain, unqualifyName, writePoint, registerPoint