DiscoveryUriString Property (UAApplicationElement)

The URL string that can be used to reach the application, using discovery.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ColumnDisplayAttribute(3)>
<DefaultValueAttribute("")>
<DisplayAttribute(AutoGenerateField=False, 
   Order=8, 
   ShortName="Discovery URI String")>
<IgnoreDataMemberAttribute()>
<XmlIgnoreAttribute()>
Public Property DiscoveryUriString As String

'Usage
 
Dim instance As UAApplicationElement
Dim value As String
 
instance.DiscoveryUriString = value
 
value = instance.DiscoveryUriString

[ColumnDisplay(3)]
[DefaultValue("")]
[Display(AutoGenerateField=false, 
   Order=8, 
   ShortName="Discovery URI String")]
[IgnoreDataMember()]
[XmlIgnore()]
public string DiscoveryUriString {get; set;}

[ColumnDisplay(3)]
[DefaultValue("")]
[Display(AutoGenerateField=false, 
   Order=8, 
   ShortName="Discovery URI String")]
[IgnoreDataMember()]
[XmlIgnore()]
public:
property String^ DiscoveryUriString {
   String^ get();
   void set (    String^ value);
}

Remarks

This value can be used as OpcLabs.BaseLib.ResourceDescriptor.UrlString.

A generic string is used instead of System.Uri, because in some cases, the value may not represent a real URI.

This value is derived from DiscoveryUriStrings. When DiscoveryUriStrings contains precisely one element, DiscoveryUriString is equal to value of this element. Otherwise, DiscoveryUriString is an empty string. Assigning a non-empty string to DiscoveryUriString clears the DiscoveryUriStrings and adds this string as a single element to the collection. Assigning an empty string to DiscoveryUriString has no effect.

Certain types of discovery queries, such as UALocalApplicationDiscoveryQuery or UALocalApplicationDiscoveryQuery with the Flat parameter set to true always return application elements which have precisely one discovery URI, and in such case it is guaranteed that DiscoveryUriString contains a non-empty string.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

UAApplicationElement Class
UAApplicationElement Members

Send Documentation Feedback. Technical Support