Xceed .NET Libraries Documentation
WindowsDiskFile Constructor(FileSystemEvents,Object,String)


Xceed.FileSystem.Windows Assembly > Xceed.FileSystem.Windows Namespace > WindowsDiskFile Class > WindowsDiskFile Constructor : WindowsDiskFile Constructor(FileSystemEvents,Object,String)
A Xceed.FileSystem.FileSystemEvents object that will be used to raise events. Cannot be a null reference (Nothing in Visual Basic).
Opaque data that will be passed back to the event handler when an event is raised.
A String that represents the fully qualified name of the underlying physical file. This file may or may not physically exist. Cannot be a null reference (Nothing in Visual Basic).
Initializes a new instance of the WindowsDiskFile class with the fully qualified name of the underlying physical file the object is to represent.
Syntax
'Declaration
 
Public Function New( _
   ByVal events As FileSystemEvents, _
   ByVal userData As Object, _
   ByVal fileName As String _
)
'Usage
 
Dim events As FileSystemEvents
Dim userData As Object
Dim fileName As String
 
Dim instance As New WindowsDiskFile(events, userData, fileName)
public WindowsDiskFile( 
   FileSystemEvents events,
   object userData,
   string fileName
)

Parameters

events
A Xceed.FileSystem.FileSystemEvents object that will be used to raise events. Cannot be a null reference (Nothing in Visual Basic).
userData
Opaque data that will be passed back to the event handler when an event is raised.
fileName
A String that represents the fully qualified name of the underlying physical file. This file may or may not physically exist. Cannot be a null reference (Nothing in Visual Basic).
Exceptions
ExceptionDescription
If fileName is a null reference (Nothing in Visual Basic).
If fileName
  • is empty, only contains whitespace
  • contains invalid characters in the context of a path
  • is an invalid file according to Windows
  • represents a folder name
    Remarks

    It is not necessary for the fileName parameter to include the \\?\ prefix. It is added and handled automatically by the component.

    The fileName parameter can include relative path information, in which ".." means "previous folder". For example: "folder/file.txt", "../file.txt", etc.

    In this context, a name is relative to the current working directory of the application.

    This method allows to initialize an object for a file that exists, as well as for a file that does not exist.

    Before an exception is thrown, the PathException event is triggered, allowing the constructor to retry the initialization with a corrected fileName value.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    WindowsDiskFile Class
    WindowsDiskFile Members
    Overload List

    Events

    PathException Event