IDatabase::Compact Method

Deprecated. Compacts the database.

Syntax

HRESULT Compact(
  [in]  IDatabaseProgress pProgress,
  [in]  dwReserved DWORD
);

Parameters

pProgress [in]

Type: IDatabaseProgress

An IDatabaseProgress object that will have IDatabaseProgress::Update called periodically during the course of compaction.

DWORD [in]

Type: dwReserved

A reserved value, should always be 0.

Return Value

Type: HRESULT

Returns one of the following values.

Return codeDescription
S_OK

The function succeeded.

DB_E_DATABASE_CHANGED

Indicates the database has changed during the course of the compaction.

DB_E_MOVEFILE

Indicates there was an error when attempting to move the database file.

DB_E_COMPACT_PREEMPTED

Indicates that the compatct operation was preempted.

 

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Product

Outlook Express 6.0

IDL

Directdb.idl

DLL

Directdb.dll (version 6.0 or later)

 

 

Send comments about this topic to Microsoft

Build date: 6/30/2011

Show: