OPC Studio User's Guide and Reference
MapFile Method



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

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

A file info to be mapped.

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

Maps a file name to a file info.
Syntax
'Declaration
 
Public Sub MapFile( _
   ByVal fileName As String, _
   ByVal fileInfo As IFileInfo2 _
) 
'Usage
 
Dim instance As MappedFileProvider
Dim fileName As String
Dim fileInfo As IFileInfo2
 
instance.MapFile(fileName, fileInfo)
public void MapFile( 
   string fileName,
   IFileInfo2 fileInfo
)
public:
void MapFile( 
   String^ fileName,
   IFileInfo2^ fileInfo
) 

Parameters

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

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

fileInfo
A file info to be mapped.

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

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