TryAssign Method (BrowsePath)

Attempts to assign an absolute browse path string to the current browse path object.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<CanBeNullAttribute()>
Public Function TryAssign( _
   ByVal absolute As String _
) As IStringParsingError

'Usage
 
Dim instance As BrowsePath
Dim absolute As String
Dim value As IStringParsingError
 
value = instance.TryAssign(absolute)

[CanBeNull()]
public IStringParsingError TryAssign( 
   string absolute
)

[CanBeNull()]
public:
IStringParsingError^ TryAssign( 
   String^ absolute
)

Parameters

absolute: The absolute browse path string to be assigned to the current browse path object.
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

If successful, the current contents of the browse path object is replaced.

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.