Folder  Object

IID_Folder

{BBCBDE60-C3FF-11CE-8350-444553540000}

IID_Folder2

{F0D2D8EF-3890-11D2-BF8B-00C04FB93661}

IID_Folder3

{F0A7AE5F64-C4D7-4D7F-9307-4D24EE54B841}

The Folder object represents a Shell folder. It contains properties and methods that allow you to retrieve information about the folder.

Remarks

Note  Not all methods are implemented for all folders. For example, the ParseName method is not implemented for the Control Panel folder (CSIDL_CONTROLS). If you attempt to call an unimplemented method, a 0x800A01BD (decimal 445) error is raised.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IDispatch Methods

Description

GetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).

GetTypeInfo

Gets the type information for an object.

GetIDsOfNames

Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs.

Invoke

Provides access to properties and methods exposed by an object.

Folder Methods and Properties

Description

Title

Contains the title of the folder.

Application

Contains the folder's Application object.

Parent

Not currently implemented.

ParentFolder

Contains the parent Folder object.

Items

Retrieves a FolderItems object that represents the collection of items in the folder.

ParseName

Creates and returns a FolderItem object that represents a specified item.

NewFolder

Creates a new folder.

MoveHere

Moves an item or items to this folder.

CopyHere

Copies an item or items to a folder.

GetDetailsOf

Retrieves details about an item in a folder. For example, its size, type, or the time of its last modification.

Folder2 Methods and Properties

Description

Self

Contains the folder's FolderItem object.

OffLineStatus

Contains the offline status of the folder.

Synchronize

Synchronizes all offline files.

HaveToShowWebViewBarricade

Not currently supported.

DimissedWebViewBarricade

Specifies that the Web view barricade has been dismissed by the user.

Folder3 Methods and Properties

Description

ShowWebViewBarricade

Ask if the WebView barricade should be shown or not

Title

FUNCTION ShellFolder_get_Title ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pbs AS STRING _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[7] USING ShellFolder_get_Title (pthis, pbs) TO HRESULT
  FUNCTION = HRESULT
  pbs = ACODE$(pbs)

END FUNCTION

Application

FUNCTION ShellFolder_get_Application ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppid AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[8] USING ShellFolder_get_Application (pthis, ppid) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Parent

FUNCTION ShellFolder_get_Parent ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppid AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[9] USING ShellFolder_get_Parent (pthis, ppid) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

ParentFolder

FUNCTION ShellFolder_get_ParentFolder ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppsf AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[10] USING ShellFolder_get_ParentFolder (pthis, ppsf) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Items

FUNCTION ShellFolder_Items ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppid AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING ShellFolder_Items (pthis, ppid) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

ParseName

FUNCTION ShellFolder_ParseName ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL bName AS STRING _
, BYREF ppid AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  bName = UCODE$(bName)
  CALL DWORD @@pthis[12] USING ShellFolder_ParseName (pthis, bName, ppid) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

NewFolder

FUNCTION ShellFolder_NewFolder ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL bName AS STRING _
, BYVAL vOptions AS VARIANT _
  ) AS LONG

  LOCAL HRESULT AS LONG
  bName = UCODE$(bName)
  CALL DWORD @@pthis[13] USING ShellFolder_NewFolder (pthis, bName, vOptions) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

MoveHere

FUNCTION ShellFolder_MoveHere ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL vItem AS VARIANT _
, BYVAL vOptions AS VARIANT _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[14] USING ShellFolder_MoveHere (pthis, vItem, vOptions) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

CopyHere

FUNCTION ShellFolder_CopyHere ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL vItem AS VARIANT _
, BYVAL vOptions AS VARIANT _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[15] USING ShellFolder_CopyHere (pthis, vItem, vOptions) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetDetailsOf

FUNCTION ShellFolder_GetDetailsOf ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL vItem AS VARIANT _
, BYVAL iColumn AS LONG _
, BYREF pbs AS STRING _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[16] USING ShellFolder_GetDetailsOf (pthis, vItem, iColumn, pbs) TO HRESULT
FUNCTION = HRESULT
  pbs = ACODE$(pbs)

END FUNCTION
 

Self

FUNCTION ShellFolder2_get_Self ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppfi AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[17] USING ShellFolder2_get_Self (pthis, ppfi) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

OffLineStatus

FUNCTION ShellFolder2_get_OfflineStatus ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pul AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[18] USING ShellFolder2_get_OfflineStatus (pthis, pul) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Synchronize

FUNCTION ShellFolder2_Synchronize ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[19] USING ShellFolder2_Synchronize (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

HaveToShowWebViewBarricade

FUNCTION ShellFolder2_get_HaveToShowWebViewBarricade ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pbHaveToShowWebViewBarricade AS INTEGER _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[20] USING ShellFolder2_get_HaveToShowWebViewBarricade (pthis, pbHaveToShowWebViewBarricade) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

DimissedWebViewBarricade

FUNCTION ShellFolder2_DismissedWebViewBarricade ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[21] USING ShellFolder2_DismissedWebViewBarricade (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

DimissedWebViewBarricade

FUNCTION ShellFolder3_get_ShowWebViewBarricade ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pbShowWebViewBarricade AS INTEGER _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[22] USING ShellFolder3_get_ShowWebViewBarricade (pthis, pbShowWebViewBarricade) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION