FromString Method (BrowsePath)

Converts a string (containing an absolute browse path) to a browse path object.

Syntax

[JetBrains.Annotations.CanBeNull()]
[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.Pure()]
public static BrowsePath FromString( 
   string value
)

[JetBrains.Annotations.CanBeNull()]
[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.Pure()]
public:
static BrowsePath^ FromString( 
   String^ value
)

'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
<JetBrains.Annotations.MustUseReturnValueAttribute()>
<JetBrains.Annotations.PureAttribute()>
Public Shared Function FromString( _
   ByVal value As String _
) As BrowsePath

'Usage
 
Dim value As String
Dim value As BrowsePath
 
value = BrowsePath.FromString(value)

Parameters

value: The string containing the absolute browse path to be parsed.
The value of this parameter can be null (Nothing in Visual Basic).

Return Value

Returns null when the input is null or an empty string. Otherwise, if the input string can be parsed, returns the corresponding browse path object.

This method can return null (Nothing in Visual Basic).

This return value of this method should not be ignored.

Exceptions

Exception	Description
OpcLabs.BaseLib.Navigation.Parsing.BrowsePathFormatException	The browse path cannot be parsed.

Remarks

The input browse path, if not null, must be absolute.

This method is pure, i.e. it does not have observable side effects.

In languages that support implicit conversions (such as C# or VB.NET), in many cases you do not have call this method explicitly. When indicated, a call to an available equivalent implicit conversion operator will be created by the compiler automatically.

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

BrowsePath Class
BrowsePath Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.