Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / AbstractFolder Class / GetFile Method / GetFile(FileSystemEvents,Object,String) Method
A FileSystemEvents object that will be used to raise events. Cannot be null.
Opaque data that will be passed back to the event handler when an event is raised.
Relative name of the file to retrieve.


In This Topic
    GetFile(FileSystemEvents,Object,String) Method
    In This Topic
    Returns an AbstractFile object that represents a file contained in the folder and raises events during the process.
    Syntax
    'Declaration
     
    
    Public Overloads Function GetFile( _
       ByVal events As FileSystemEvents, _
       ByVal userData As Object, _
       ByVal relativeName As String _
    ) As AbstractFile
    'Usage
     
    
    Dim instance As AbstractFolder
    Dim events As FileSystemEvents
    Dim userData As Object
    Dim relativeName As String
    Dim value As AbstractFile
     
    value = instance.GetFile(events, userData, relativeName)

    Parameters

    events
    A FileSystemEvents object that will be used to raise events. Cannot be null.
    userData
    Opaque data that will be passed back to the event handler when an event is raised.
    relativeName
    Relative name of the file to retrieve.

    Return Value

    An AbstractFile object representing the file named relativeName.
    Remarks

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

    This method allows to get a reference to an AbstractFile object for a file that exists, as well as for a file that does not exist. Further, the folder on which this method is called may not exist.

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also