IABContainer Interface

IID_IABContainer

{0002030D-0000-0000-C000-000000000046}

The IABContainer interface provides access to address book containers. MAPI and client applications call the methods of IABContainer to perform name resolution and to create, copy, and delete recipients.

The IABContainer interface inherits indirectly from IUnknown through IMAPIContainer and IMAPIProp. Address book providers implement IABContainer.

Any number of messaging user objects, distribution lists, and other address book containers can exist within an address book container. As with any container, clients or service providers can use an address book container to open one of its entries or to retrieve a hierarchy table or contents table. Address book containers also provide name resolution and, depending on the provider, the ability to add, remove, or modify entries.

MAPI defines a special address book container, called the personal address book (PAB), that is meant to hold entries copied from other containers. A PAB is always modifiable. Users typically populate their PAB with entries designating the recipients with which they most frequently communicate. A PAB can also hold one-off addresses new recipients not yet a part of any address book container.

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

Not currently implemented.

SaveChanges

Not currently implemented.

GetProps

Not currently implemented.

GetPropList

Not currently implemented.

OpenProperty

Not currently implemented.

SetProps

Not currently implemented.

DeleteProps

Not currently implemented.

CopyTo

Not currently implemented.

CopyProps

Not currently implemented.

GetNamesFromIDs

Not currently implemented.

GetIDsFromNames

Not currently implemented.

IMAPIContainer Methods

Description

GetContentsTable

Returns a pointer to the container's contents table.

GetHierarchyTable

Not currently implemented.

OpenEntry

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

SetSearchCriteria

Not currently implemented.

GetSearchCriteria

Not currently implemented.

IABContainer Methods

Description

CreateEntry

Creates a new entry, which can be a messaging user, a distribution list, or another container.

CopyEntries

Not currently implemented.

DeleteEntries

Removes one or more entries, typically messaging users, distribution lists, or other containers.

ResolveNames

Performs name resolution for one or more recipient entries.

CreateEntry

FUNCTION IABContainer_CreateEntry ( _
  BYVAL pIABContainer AS DWORD PTR _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
, BYVAL ulCreateFlags AS DWORD _
, BYREF lppIMAPIPropEntry AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIABContainer[19] USING IABContainer_CreateEntry (pIABContainer, cbEntryID, lpEntryID, ulCreateFlags, lppIMAPIPropEntry) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CopyEntries

FUNCTION IABContainer_CopyEntries ( _
  BYVAL pIABContainer AS DWORD PTR _
, BYVAL lpEntries AS DWORD _
, BYVAL ulUIParam AS DWORD _
, BYVAL lpProgress AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIABContainer[20] USING IABContainer_CopyEntries (pIABContainer, lpEntries, ulUIParam, lpProgress, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

DeleteEntries

FUNCTION IABContainer_DeleteEntries ( _
  BYVAL pIABContainer AS DWORD PTR _
, BYVAL lpEntries AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIABContainer[21] USING IABContainer_DeleteEntries (pIABContainer, lpEntries, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

ResolveNames

FUNCTION IABContainer_ResolveNames ( _
  BYVAL pIABContainer AS DWORD PTR _
, BYREF lpPropTagArray AS SpropTagARray _
, BYVAL ulFlags AS DWORD _
, BYVAL lpAdrList AS ADRLIST PTR _
, BYVAL lpFlagList AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIABContainer[22] USING IABContainer_ResolveNames (pIABContainer, lpPropTagArray, ulFlags, lpAdrList, lpFlagList) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION