IMAPIContainer Interface

IID_IMAPIContainer

{0002030B-0000-0000-C000-000000000046}

The IMAPIContainer interface manages high-level operations on container objects such as folders.

This interface inherits from IMAPIProp.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMAPIProp Methods

Description

GetLastError

Returns a MAPIERROR structure containing information about the previous error.

SaveChanges

Makes permanent any changes made to an object since the last save operation.

GetProps

Retrieves one or more properties.

GetPropList

Returns property tags for all properties.

OpenProperty

Returns a pointer to an interface to be used to access a property.

SetProps

Updates one or more properties.

DeleteProps

Deletes one or more properties.

CopyTo

Copies or moves all properties, except for specifically excluded properties.

CopyProps

Copies or moves selected properties.

GetNamesFromIDs

Provides the property names that correspond to one or more property identifiers.

GetIDsFromNames

Provides the property identifiers that correspond to one or more property names.

IMAPIContainer Methods

Description

GetContentsTable

Returns a pointer to the container's contents table.

GetHierarchyTable

Returns a pointer to the container's hierarchy table.

OpenEntry

Opens an object within the container, returning an interface pointer for further access.

SetSearchCriteria

Establishes search criteria for the container.

GetSearchCriteria

Obtains the search criteria for the container.

GetContentsTable

FUNCTION IMAPIContainer_GetContentsTable ( _
  BYVAL pIMAPIContainer AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lppTable AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIContainer[14] USING IMAPIContainer_GetContentsTable (pIMAPIContainer, ulFlags, lppTable) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetHierarchyTable

FUNCTION IMAPIContainer_GetHierarchyTable ( _
  BYVAL pIMAPIContainer AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lppTable AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIContainer[15] USING IMAPIContainer_GetHierarchyTable (pIMAPIContainer, ulFlags, lppTable) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

OpenEntry

FUNCTION IMAPIContainer_OpenEntry ( _
  BYVAL pIMAPIContainer AS DWORD PTR _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
, BYREF lpInterface AS GUID _
, BYVAL ulFlags AS DWORD _
, BYREF lpulObjType AS DWORD _
, BYREF lppUnk AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIContainer[16] USING IMAPIContainer_OpenEntry (pIMAPIContainer, cbEntryID, lpEntryID, lpInterface, ulFlags, lpulObjType, lppUnk) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetSearchCriteria

FUNCTION IMAPIContainer_SetSearchCriteria ( _
  BYVAL pIMAPIContainer AS DWORD PTR _
, BYREF lpRestriction AS SRestriction _
, BYVAL lpContainerList AS DWORD _
, BYVAL ulSearchFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIContainer[17] USING IMAPIContainer_SetSearchCriteria (pIMAPIContainer, lpRestriction, lpContainerList, ulSearchFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetSearchCriteria

FUNCTION IMAPIContainer_GetSearchCriteria ( _
  BYVAL pIMAPIContainer AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lppRestriction AS DWORD _
, BYREF lppContainerList AS DWORD _
, BYREF lpulSearchState AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIContainer[18] USING IMAPIContainer_GetSearchCriteria (pIMAPIContainer, ulFlags, lppRestriction, lppContainerList, lpulSearchState) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION