TryParseRelative Method (_BrowsePathParser)

Attempts to parse a string containing a relative browse path.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<CanBeNullAttribute()>
Function TryParseRelative( _
   ByVal value As String, _
   ByVal stringCollection As Object _
) As StringParsingError

'Usage
 
Dim instance As _BrowsePathParser
Dim value As String
Dim stringCollection As Object
Dim value As StringParsingError
 
value = instance.TryParseRelative(value, stringCollection)

[CanBeNull()]
StringParsingError TryParseRelative( 
   string value,
   object stringCollection
)

[CanBeNull()]
StringParsingError^ TryParseRelative( 
   String^ value,
   Object^ stringCollection
)

Parameters

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

Return Value

Returns null if successful; otherwise, some OpcLabs.BaseLib.IStringParsingError indicating the reason of the failure.

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

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

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

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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

_BrowsePathParser Interface
_BrowsePathParser 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.