SftDirectory 2.5

SftDirectory.Folder Property

Softel vdm, Inc.

Returns a SftDirectoryFolder object given a file/folder's absolute path.

Syntax       

Get

VB.NET

refFolderObj = object.get_Folder(ByVal FullPath As String)  As SftDirectoryFolder

VB

Set refFolderObj = object.Folder(ByVal FullPath As String)  As SftDirectoryFolder

C#.NET

SftDirectoryFolder refFolderObj = object.get_Folder(string FullPath);

VC++

ISftDirectoryFolder* refFolderObj = object->Folder[_bstr_t FullPath];
ISftDirectoryFolder* refFolderObj = object->GetFolder(_bstr_t FullPath);

C

HRESULT object->get_Folder(BSTR FullPath, ISftDirectoryFolder** refFolderObj);

Delphi

refFolderObj := object.Folder[FullPath : WideString]  : ISftDirectoryFolder;

object

A SftDirectory object.

FullPath

A string value containing the fully qualified path of the folder to return.

refFolderObj

Returns a SftDirectoryFolder object given a file/folder's absolute path.

Comments

The Folder property returns a SftDirectoryFolder object given a file/folder's absolute path.

If the specified folder is not already present in the folder list, it is added to the control and all its parent folders are expanded.  If the path is only partially valid, all valid initial folders are added and expanded.  If the specified path is already present (even if part of a collapsed parent folder), its refFolderObj reference is returned. Parent folders are not expanded.

If the specified path cannot be found, the return value is Nothing (NULL).

The root folder cannot be located using the Folder property.

The FolderUsingIDL property can be used to retrieve a SftDirectoryFolder object given an ITEMIDLIST structure.


Feedback / comments / error reports for this topic
© 2003, 2008 - Softel vdm, Inc. - www.softelvdm.com