Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / AbstractFolder Class / GetFolder Method / GetFolder(FileSystemEvents,Object,String) Method
A 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.
Relative name of the folder to retrieve.


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

    Parameters

    events
    A 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.
    relativeName
    Relative name of the folder to retrieve.

    Return Value

    An AbstractFolder object representing the folder named relativeName.
    Remarks

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

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

    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