OPC Studio User's Guide and Reference
IsFileMapped Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Extensions.FileProviders Namespace > MappedFileProvider Class : IsFileMapped Method
A name of the file (in the root directory).

The value of this parameter cannot be null (Nothing in Visual Basic).

Tests whether a file name is mapped.
Syntax
'Declaration
 
Public Function IsFileMapped( _
   ByVal fileName As String _
) As Boolean
'Usage
 
Dim instance As MappedFileProvider
Dim fileName As String
Dim value As Boolean
 
value = instance.IsFileMapped(fileName)
public bool IsFileMapped( 
   string fileName
)
public:
bool IsFileMapped( 
   String^ fileName
) 

Parameters

fileName
A name of the file (in the root directory).

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns true if the fileName is mapped to a file info; returns false otherwise.
Exceptions
ExceptionDescription

One of the arguments provided to a method is not valid.

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.

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

The file name (fileName) must not be null or empty.

Requirements

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

See Also