EV10 API Reference

8/21/2019 EV10 API Reference

1/652

Symantec Enterprise Vault™

Application Programmer's Guide

10.0


2/652

Symantec Enterprise Vault: Application Programmer'sGuide

Thesoftware describedin this book is furnishedundera license agreement and may be used

only in accordance with the terms of the agreement.

Last updated: 2012-02-27.

Legal Notice

Copyright © 2012 Symantec Corporation. All rights reserved.

Symantec, the Symantec Logo, Veritas, Enterprise Vault, Compliance Accelerator, and

Discovery Accelerator are trademarks or registered trademarks of Symantec Corporation

or its affiliates in the U.S. and other countries. Other names may be trademarks of their

respective owners.

This Symantec product may contain third party software for which Symantec is required

to provide attribution to the third party (“Third Party Programs”). Some of the Third Party

Programs are availableunder open source or free software licenses.The License Agreement

accompanying the Software does not alter any rights or obligations you may have under

those open source or free software licenses. Please see the ThirdParty Software file

accompanying this Symantec product for more information on the Third Party Programs.

The product described in this document is distributed under licenses restricting its use,

copying, distribution, and decompilation/reverse engineering. No part of this document

may be reproduced in any form by any means without prior written authorization of

Symantec Corporation and its licensors, if any.

THE DOCUMENTATIONIS PROVIDED"ASIS" ANDALL EXPRESS OR IMPLIED CONDITIONS,

REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT,

ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO

BE LEGALLYINVALID. SYMANTECCORPORATION SHALL NOTBELIABLEFORINCIDENTAL

OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING,

PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE INFORMATION CONTAINED

IN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE.

The LicensedSoftwareand Documentation are deemed to be commercial computer software

as defined in FAR12.212 andsubjectto restricted rights as defined in FARSection 52.227-19

"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, "Rights inCommercial Computer Software or Commercial Computer Software Documentation", as

applicable, and any successor regulations. Any use, modification, reproduction release,

performance, display or disclosure of theLicensedSoftware andDocumentation by the U.S.

Government shall be solely in accordance with the terms of this Agreement.

Symantec Corporation

350 Ellis Street, Mountain View, CA 94043

http://www.symantec.com

http://www.symantec.com/http://www.symantec.com/


3/652

Technical Support

In order to develop software using Enterprise Vault APIs, your company must be

a member of Symantec Technology Enabled Program (STEP).

For details of the technical support available to you, refer to your STEP

membership documentation, or contact the STEP office at

[email protected].

Further information about STEP is available at the following address:

http://go.symantec.com/step

http://go.symantec.com/stephttp://go.symantec.com/step


4/652


5/652

Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 1 About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Introducing this guide .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Enterprise Vault documentation .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 19

Comment on the documentation .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 19

Chapter 2 API updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

About API updates .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Enterprise Vault 10.0.1 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Enterprise Vault 10.0 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Enterprise Vault 9.0 SP3 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Enterprise Vault 9.0 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26




Enterprise Vault 8.0 SP2 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 32Enterprise Vault 8.0 SP1 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 32


Minimum supported OS version .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 34

Changes to programming language support .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

General changes .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

NSF Manager API added .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 34

Content Management API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 35

Retention API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Migration API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

New index properties added .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 38

Corrections .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39


Enterprise Vault 2007 SP1, Enterprise Vault 7.0 SP3, and Enterprise

Vault 6.0 SP5 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Enterprise Vault 2007, Enterprise Vault 7.0 SP2, and Enterprise Vault

6.0 SP4 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 42


Contents


6/652

Chapter 3 Enterprise Vault API overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 47

About API overview ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Overview of Enterprise Vault APIs .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 47

Prerequisite software and settings .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 49

Permissions .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 49

Licensing .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 50

Development licensing .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 50

Production licensing .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 50

Deploying an application that uses the API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 51

Enterprise Vault API runtime MSI .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 51

Checking the API runtime version and the installation path .. . . . . . . . . . 51

Deploying .NET applications .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 53

Installing the Enterprise Vault SDK ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 54

Checking the SDK version and installation path .. . . . . . . . . . . . . . . . . . . . . . . . . . 55SDK examples .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Programming notes .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Using the Enterprise Vault APIs in C++ ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 56

Using Enterprise Vault APIs in .NET managed languages .. . . . . . . . . . . . . 56

Using Enterprise Vault APIs in Visual Basic Script . . . . . . . . . . . . . . . . . . . . . . . 57

Code samples .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Chapter 4 Content Management API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 59

About the Content Management API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 65

Architecture of Content Management API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66General guidelines for using the API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 69

Use of objects .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Enumerating vault stores, archives and items ... . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Saveset IDs and Transaction IDs .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 71

Property validation .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

How Enterprise Vault processes message items ... . . . . . . . . . . . . . . . . . . . . . . . . 72

Adding custom index metadata .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 72

Audit logging .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Diagnostic logging and tracing .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . 75

Enumerations .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 75

EV_API_DELETION_LEVEL enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 75

EV_API_EVENT_TYPE enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 76

EV_API_ITEMS_ORDERBY enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 76

EV_API_TRACE_LEVEL enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 76

EV_STG_API_ARCHIVE_TYPE enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

EV_STG_API_AUTHENTICATE_USING enumeration .. . . . . . . . . . . . . . . . . . . 77

EV_STG_API_CAN_DELETE enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

EV_STG_API_CONVERTED_CONTENT enumeration .. . . . . . . . . . . . . . . . . . . 79

Contents6


7/652

EV_STG_API_CP_SETBY enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

EV_STG_API_CP_UNITS enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 80

EV_STG_API_DELETION_REASON enumeration .. . . . . . . . . . . . . . . . . . . . . . . . 80

EV_STG_API_EXPIRE_ITEMS enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81EV_STG_API_INDEX_LEVEL enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

EV_STG_API_INDEX_URGENCY enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

EV_STG_API_ITEM_COPYOPTIONS enumeration .. . . . . . . . . . . . . . . . . . . . . . . 82

EV_STG_API_ITEM_DETAIL enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

EV_STG_API_PERMISSIONS_TYPE enumeration .. . . . . . . . . . . . . . . . . . . . . . . . 85

EV_STG_API_STATUS enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . 86

ContentManagementAPI object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 87

IContentManagementAPI :: Archive .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 91

IContentManagementAPI :: Item ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 93

IContentManagementAPI :: Holds .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 94

IContentManagementAPI :: Hold .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 96IContentManagementAPI :: DirectoryDNSAlias .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

IContentManagementAPI :: AuthenticationMode .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

IContentManagementAPI2 :: VaultStores .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 100

IContentManagementAPI2 :: VaultStore .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 101

IContentManagementAPI2 :: Archives .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 103

IContentManagementAPI3 :: Items ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 103

IContentManagementAPI3 :: IDispatchQueryInterface .. . . . . . . . . . . . . . . . . . . . . 104

IContentManagementAPI4 :: LastError .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 106

VaultStores object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

IVaultStores :: Computer .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 109VaultStore object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

IVaultStore :: Id .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 112

IVaultStore :: Name ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

IVaultStore :: Description .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 114

IVaultStore :: Status .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

IVaultStore :: ArchiveCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 116

IVaultStore :: DirectoryDNSAlias .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 117

IVaultStore :: Get .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Archives object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

IArchives :: Computer .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

IArchives :: VaultStoreId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 123IArchives :: ArchiveName ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 124

IArchives :: Permissions .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

IArchives :: ArchiveTypes .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 127

Archive object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 128

IArchive :: VaultStoreId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

IArchive :: Id .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 132

IArchive :: Name ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Contents


8/652

IArchive :: Description .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

IArchive :: ExpireItems ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

IArchive :: ConvertedContent .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 138

IArchive :: IndexUrgency .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 140IArchive :: IndexLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

IArchive :: Size .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 143

IArchive :: SecurityDescriptor .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 145

IArchive :: ComplianceDevice .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 147

IArchive :: ItemCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

IArchive :: Create .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

IArchive :: Get .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 152

IArchive2 :: Type .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

IArchive2 :: Status .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

IArchive2 :: HasFolders .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

IArchive2 :: Full . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 156IArchive2 :: DirectoryDNSAlias .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 157

IArchive3 :: SecurityDescriptor .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 157

IArchive3 :: SecurityDescriptorString .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 159

IArchive3 :: Type .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Items object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 164

IItems :: ArchiveId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

IItems :: StartSequenceNum ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 169

IItems :: OrderBy .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Item object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 172

IItem :: ArchiveId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174IItem :: Id .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . 175

IItem :: Content .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 177

IItem :: ArchiveMetaData .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

IItem :: BrowserViewURL ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 179

IItem :: DefaultMSGFormat .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 181

IItem :: Holds .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

IItem :: NativeItemURL ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 184

IItem :: DeletionLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

IItem :: CopyOptions .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

IItem :: Insert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 191

IItem :: Get .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 194IItem :: Delete .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 198

IItem :: CanBeDeleted .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

IItem :: CopyTo ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

IItem :: MoveTo ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

IItem2 :: DeletionReason ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

IItem3 :: Undelete .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Content object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 212

Contents8


9/652

IContent :: Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

IContent :: OriginalLocation .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 214

IContent :: FileExtension .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 215

IContent :: MIMEFormat .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 217IContent :: CreatedDate .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 218

IContent :: ModifiedDate .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 219

IContent :: Data .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

IContent :: OriginalSize .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 222

IContent :: Author .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

ArchiveMetaData object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

IArchiveMetaData :: RetentionCategory .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . 228

IArchiveMetaData :: ComplianceDevice .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . 229

IArchiveMetaData :: OverrideOnHoldRetCat .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 230

IArchiveMetaData :: ArchivedDate .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 232

IArchiveMetaData :: ComplianceData .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 233IArchiveMetaData :: SavesetSize .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 234

IArchiveMetaData :: RetentionExpires .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 235

IArchiveMetaData :: IndexData .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 236

IArchiveMetaData :: IsItemSecured .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . 237

IIArchiveMetaData :: CustomIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 239

IIArchiveMetaData :: CustomQualifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 240

IIArchiveMetaData :: CustomProperties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 242

IArchiveMetaData :: Update .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 243

IArchiveMetaData2 :: CurrentLocation .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 245

IArchiveMetaData2 :: CurrentFolderId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . 251IArchiveMetaData2 :: SequenceNum ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 253

IArchiveMetaData2 :: ArchivedDate .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . 255

SimpleIndexMetadata object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 256

ISimpleIndexMetadata :: _NewEnum ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 259

ISimpleIndexMetadata :: DateTimesUTC ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 260

ISimpleIndexMetadata :: Count .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 261

ISimpleIndexMetadata :: Add .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 262

ISimpleIndexMetadata :: Clear .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 265

ISimpleIndexMetadata :: ToXML ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 265

ISimpleIndexMetadata :: FromXML ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . 267

ISimpleIndexMetadata :: ToLocalTime ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . 268ISimpleIndexMetadata :: ToUTCTime ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . 269

SimpleIndexProperty object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 269

ISimpleIndexProperty :: Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 270

ISimpleIndexProperty :: Name ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 272

ISimpleIndexProperty :: Value .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 275

ISimpleIndexProperty :: Searchable .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . 277

ISimpleIndexProperty :: Retrievable .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 278

Contents


10/652

ISimpleIndexProperty :: System ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 279

ComplianceData object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

IComplianceData :: Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 282

IComplianceData :: Value .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 283IComplianceData :: SetBy .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 284

Holds object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 285

IHolds :: _NewEnum ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

IHolds :: Item ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

IHolds :: Count .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 289

IHolds :: GroupId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

IHolds :: ConsumerGUID ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 292

IHolds :: Metadata .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

IHolds :: Add .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 294

IHolds :: PlaceHolds .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

IHolds :: ReleaseHolds .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 296IHolds2 :: ReleaseHolds2 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 298

Hold object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 300

IHold :: ArchiveId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

IHold :: ItemId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 302

IHold :: Id .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 304

IHold :: Status .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 305

IHold :: Metadata .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

IHold :: ConsumerGUID ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 306

IHold :: GroupId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

ICollectionBase : IDispatch .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 308ICollectionBase :: Count .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 309

ICollectionBase :: _NewEnum ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 310

ICollectionBase :: Item ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

ICollectionBase :: Maximum ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 312

ICollectionBase :: More .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

ICollectionBase :: Get .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

ICollectionBase :: Clear .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

ICollectionBase :: Reset .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 315

ExtendedErrorInfo object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

IExtendedErrorInfo :: Error .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 320

IExtendedErrorInfo :: Description .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 320IExtendedErrorInfo :: InnerError .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 321

IExtendedErrorInfo :: InnerErrorDescription .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

IExtendedErrorInfo :: Source .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 322

DiagnosticsAPI object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

IDiagnosticsAPI : Name ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 324

IDiagnosticsAPI : IsTraceEnabled .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 325

IDiagnosticsAPI : LogEvent .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 325

Contents10


11/652

IDiagnosticsAPI : Trace .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 326

Chapter 5 NSF Manager API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 329

About NSF Manager API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 329

NSF Manager API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

Components .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

Security .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 331

Enumerations .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

InitializeNotes enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 332

NSFManager object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

INSFManager :: OpenNSF ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 333

INSFManager :: CreateNSF ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 334

INSFManager :: CloseNSF ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 335

INSFManager :: ViewNote .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 336INSFManager :: ImportNote .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 337

INSFManager :: ExportNote .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 338

INSFManager :: DeleteNote .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 339

INSFManager :: InitializeNotes .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 340

INSFManager :: TerminateNotes .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 341

INSFManager :: SwitchToID ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 342

Chapter 6 Filtering APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

About the Filtering APIs .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 348

Exchange Filtering API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 350Developing Exchange external filters .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

Exchange filtering registry settings .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 352

Enumerations (Exchange filtering) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 356

EV_ACTION enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 356

EV_ATTACHMENT_ACTION enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

EV_RETRY_STATUS enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 357

EV_REARCHIVE_STATUS enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

Message direction enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 358

IExternalFilter interface .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

IExternalFilter :: Initialize .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 359

IExternalFilter :: ProcessFilter .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 359

IExternalFilter :: FilteringComplete .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 360

IArchivingControl interface for Exchange filtering .. . . . . . . . . . . . . . . . . . . . . . . . . . 360

IArchivingControl :: currentVaultId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 365

IArchivingControl :: currentRetentionCategoryId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

IArchivingControl :: defaultRetentionCategoryId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

IArchivingControl :: deleteOriginalItem ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 367

IArchivingControl :: createShortcutToItem ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 367

Contents


12/652

IArchivingControl :: Action .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 368

IArchivingControl :: MAPISession .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 368

IArchivingControl :: MAPIMessage .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 369

IArchivingControl :: AddIndexedProperty .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 369IArchivingControl :: IndexedPropertiesSet .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 370

IArchivingControl :: AddIndexPropertyToSet .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

IArchivingControl :: AddIndexPropertySet .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

IArchivingControl :: TransactionID ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 373

IArchivingControl :: AgentType .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 373

IArchivingControl :: AgentAssignedRetentionCategoryId .. . . . . . . . . . . . . . . . . . 374

IArchivingControl :: AgentAssignedVaultId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

IArchivingControl :: GetFilterProperty .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 375

IArchivingControl :: PutFilterProperty .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 375

IArchivingControl :: AttachmentAction .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . 376

IArchivingControl :: RetryStatus .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 377IArchivingControl :: ReArchiveStatus .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 378

IArchivingControl2 :: BrowserViewURL ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 378

IArchivingControl2 :: NativeItemURL ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . 379

IArchivingControl2 :: MessageClass .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 380

IArchivingControl2 :: MAPISaveChanges .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 381

IArchivingControl3 :: SenderRecipientXML ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

IArchivingControl3 :: EnvelopeSenderRecipientXML ... . . . . . . . . . . . . . . . . . . . . . . 383

IArchivingControl3 :: MessageDirection .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 385

IArchivingControl4 :: AddIndexedPropertyEx .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

Domino Filtering and File System Filtering APIs .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389About the Domino Filtering API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 389

About the File System Filtering API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 391

Developing external filters .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 393

Domino filtering registry settings .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 394

File System filtering registry settings .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . 395

Enumerations (Domino filtering) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 397

Message direction enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 397

Domino action enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 397

Enumerations (File System Filtering) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 398

File System Archiving action enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

IExternalFilter interface .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 399IExternalFilter :: Initialize .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 400

IExternalFilter :: ProcessFilter .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 400

IExternalFilter :: FilteringComplete .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 401

IExternalFilter :: Shutdown ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 401

IArchivingControl interface .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 402

IArchivingControl :: OriginalVaultID .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 403

IArchivingControl :: CurrentVaultID .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 403

Contents12


13/652

IArchivingControl :: OriginalRetentionCategoryID ... . . . . . . . . . . . . . . . . . . . . . . . . . 404

IArchivingControl :: CurrentRetentionCategoryID ... . . . . . . . . . . . . . . . . . . . . . . . . . 404

IArchivingControl :: IndexData .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 405

IArchivingControl :: FilterProperties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . 405ILotusArchivingControl interface .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 406

ILotusArchivingControl :: Action .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 406

ILotusArchivingControl :: NoteHandle .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 407

ILotusArchivingControl :: DatabaseHandle .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 407

ILotusArchivingControl :: DatabaseName ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 407

ILotusArchivingControl :: SenderRecipientXML ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

ILotusArchivingControl :: StoreIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 409

ILotusArchivingControl :: Direction .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . 410

IFileArchivingControl interface .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 410

IFileArchivingControl :: Action .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 411

IFileArchivingControl :: Name ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 412IFileArchivingControl :: Attributes .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 413

IFileArchivingControl :: CreationTimeUtc .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 414

IFileArchivingControl :: LastAccessTimeUtc .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

IFileArchivingControl :: LastWriteTimeUtc .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 416

IFileArchivingControl :: GetAccessControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 417

IFileArchivingControl :: SetAccessControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 417

IFileArchivingControl :: Length .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 418

IFileArchivingControl :: Open ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 418

IFileArchivingControl :: StreamNames .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 420

IFileArchivingControl :: OpenStream ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 420IFileArchivingControl :: DeleteStream ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 422

IFileArchivingControl :: ExtendedAttributes .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

IIndexMetadata interface .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 424

IIndexMetadata :: ToXML ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 425

IIndexMetadata :: FromXML ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 425

IIndexMetadata :: Add .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

IIndexMetadata :: Clear .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

IIndexMetadata :: Count .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

IIndexMetadata :: DateTimesUTC ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . 428

IIndexProperty interface .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 428

IIndexProperty :: Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430IIndexProperty :: Name ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

IIndexProperty :: Value .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 430

IIndexProperty :: Searchable .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 431

IIndexProperty :: Retrievable .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 431

IKeyedList interface .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

IKeyedList :: Insert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432

IKeyedList :: RemoveAt .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

Contents


14/652

Chapter 7 Search API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435

About Search API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438

About storing data in Enterprise Vault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 438

Introduction to Enterprise Vault indexing .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

Index Servers and Index Server groups .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 439

About index volumes .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 441

About indexing options .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 442

About index properties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 443

Granularity of search results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 443

Using the Search API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

Constructing a search query .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 446

ESQfilter searches .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

Special characters in search queries .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 449

Performing a search .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 449Processing the search results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 452

Enterprise Vault index properties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 453

Search API example .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 453

Constants and enumerations .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 457

Index Property constants .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 457

ESearchQueryFlags enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 458

ESearchQueryOperators enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 459

ESearchOperatorScope enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 459

EOptionsFlags enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 460

EPropertySets enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 460

ETruncationReason enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 461

EXMLResultsFormatOptions enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

SearchQuery object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

ISearchQuery :: Query .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 464

ISearchQuery :: Clear .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

ISearchQuery :: SetTerm ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

ISearchQuery :: AddTerm ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 468

ISearchQuery :: SetRange .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 470

ISearchQuery :: AddRange .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 472

ISearchQuery :: SetProperty .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 474

ISearchQuery :: AddProperty .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 476ISearchQuery :: AddOp ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 478

ISearchQuery :: Combine .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 479

ISearchQuery :: AddQuery .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 481

ISearchQuery2 :: SetPropertyRange .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 482

ISearchQuery2 :: AddPropertyRange .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 484

IndexSearch object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485

IIndexSearch2 :: IndexVolumeSets .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 489

Contents14


15/652

IIndexSearch2 :: Options .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 490

IIndexSearch2 :: SortBy .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 491

IIndexSearch2 :: ResultsPropertySet .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 493

IIndexSearch2 :: AdditionalResultsProperties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494IIndexSearch2 :: Timeout .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 495

IIndexSearch2 :: ArchiveEntryId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 497

IIndexSearch2 :: ArchiveName ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 497

IIndexSearch2 :: HasFolders .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 498

IIndexSearch2 :: IndexVolumeSetIdentity .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 499

IIndexSearch2 :: IndexVolumeIdentity .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 500

IIndexSearch2 :: IndexVolumeSetCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . 501

IIndexSearch2 :: MaxSearchIndexVolumeSets .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

IIndexSearch2 :: MaxSearchResultsPerVolumeSet .. . . . . . . . . . . . . . . . . . . . . . . . . . . 504

IIndexSearch2 :: SelectArchive .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 505

IIndexSearch2 :: ListIndexVolumeSets .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . 506IIndexSearch2 :: SelectIndexVolumeSet .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 508

IIndexSearch2 :: SelectIndexVolume ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 510

IIndexSearch2 :: Search .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511

IIndexSearch2 :: SearchToXML ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 514

IIndexSearch2 :: AddAdditionalResultsProperty .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

IIndexSearch2 :: AddAdditionalResultsCustomProperty .. . . . . . . . . . . . . . . . . . . 518

IIndexSearch2 :: Reset .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

IndexVolumeSets object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 519

IIndexVolumeSets :: ArchiveEntryId .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 521

IIndexVolumeSets :: ArchiveName ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . 522IIndexVolumeSets :: HasFolders .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 522

IIndexVolumeSets :: Count .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 523

IIndexVolumeSets :: _NewEnum ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 524

IIndexVolumeSets :: Item ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 525

IndexVolumeSet object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

IIndexVolumeSet :: Identity .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 528

IIndexVolumeSet :: ArchiveEntryID ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . 529

IIndexVolumeSet :: ArchiveName ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 530

IIndexVolumeSet :: FirstItemIndexSequenceNumber .. . . . . . . . . . . . . . . . . . . . . . . 531

IIndexVolumeSet :: OldestArchivedDate .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 531

IIndexVolumeSet :: YoungestArchivedDate .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 532IIndexVolumeSet :: OldestItemDate .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 533

IIndexVolumeSet :: YoungestItemDate .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . 534

IIndexVolumeSet :: DateTimesUTC ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 534

SearchResults object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536

ISearchResults :: Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 538

ISearchResults :: Count .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 539

ISearchResults :: Total . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 540

Contents


16/652

ISearchResults :: Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 541

ISearchResults :: Options .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 542

ISearchResults :: SortBy .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 543

ISearchResults :: _NewEnum ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 543ISearchResults :: Item ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 545

ISearchResults2 :: InSync .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 546

ISearchResults2 :: TruncationReason ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 547

ISearchResults2 :: DateTimesUTC ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 548

ISearchResults2 :: LoadResults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 549

SearchResult object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550

ISearchResult :: Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 551

ISearchResult :: Number .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 552

ISearchResult :: Prop .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553

ISearchResult :: Prop2 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554

ISearchResult2 :: Count .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 556ISearchResult2 :: Item ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557

ISearchResult2 :: DateTimesUTC ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 558

Chapter 8 Retention API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561

About Retention API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562

Retention API .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562

Components .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562

Security .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 563

Enumerations .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 563

Retention Units enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 563

Retention Date Basis enumeration .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . 563

RetentionCategories object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 564

IRetentionCategories :: Count .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 565

IRetentionCategories :: _NewEnum ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 567

IRetentionCategories :: Item ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 568

IRetentionCategories :: DirectoryDNSAlias .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . 569

IRetentionCategories :: Lookup ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 571

IRetentionCategories :: Create .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 572

IRetentionCategories :: Add .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 574

IRetentionCategories :: Update .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 576IRetentionCategories2 :: Get .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 577

RetentionCategory object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 578

IRetentionCategory :: Period .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 579

IRetentionCategory :: Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 581

IRetentionCategory :: IsVisible .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 583

IRetentionCategory :: Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 585

IRetentionCategory :: Name ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 587

Contents16


17/652

IRetentionCategory :: Description .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 588

IRetentionCategory :: OnHold .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 589

IRetentionCategory :: Locked .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 591

IRetentionCategory2 :: ExpiryBasis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 593

Appendix A Enterprise Vault properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . 595

About Enterprise Vault properties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 595

System properties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596

Note 1 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 609

Note 2 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 609

Note 3 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 610

Note 4 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 610

Note 5 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 611

Note 6 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 612Version information .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . 613

Defined custom properties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 614

Note 1 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 615

Note 2 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 615

Defined custom FSA properties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 616

Defined custom SharePoint properties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . 616

Defined properties for Compliance Accelerator .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617

Appendix B API return values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 619

About API return values .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 619Content Management API return values .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . 619

Retention API return values .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 620

Search API return values .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 621

External Filter API Event log messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . 623

Exchange Server filtering .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . 623

Domino Server filtering .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 624

File System filtering .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625

Appendix C Understanding how Enterprise Vault archives and

indexes messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 627About storing and retrieving message items ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627

Exchange (MAPI) messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 628

How the Enterprise Vault archiving agent processes Exchange

mailbox messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 628

How the Content Management API processes Exchange mailbox

messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633

Contents


18/652

How the Enterprise Vault archiving agent processes Exchange

envelope journal messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 640

How the Content Management API processes Exchange envelope

journal messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 640Lotus Notes messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . 641

Howthe Enterprise Vault archiving agent processes Lotus Notes

mailbox messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 641

How theContent Management APIprocesses Lotus Notes mailbox

messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645

Howthe Enterprise Vault archiving agent processes Lotus Notes

journal messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 646

How the Content ManagementAPI processes Lotus Notes journal

messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647

SMTP messages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648

How the Content Management API processes SMTPmessages .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648

Copying message items ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650

Intra-site copying of archived items ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 650

Inter-site copying of archived items ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . 651

Why a retrieved item is not a binary copy of the original item ... . . . . . . . . . . 652

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 653

Contents18


19/652

About this guide

This chapter includes the following topics:

■ Introducing this guide

■ Enterprise Vault documentation

■ Comment on the documentation

Introducing this guideThis book describes the publicly available Application Programming Interfaces

(APIs) for Symantec Enterprise Vault. These enable developers to integrate

Enterprise Vault features with third-party applications.

The information in this manual relates to Symantec Enterprise Vault 6.0 SP5 and

later releases.

Readers are assumed to have a good knowledge of Windows application

development languages and tools, in particular, C++/C#, COM, DCOM, and .NET.

Enterprise Vault documentationThis book is available as HTML Help and as a PDF file from Symantec Technology

Enabled Program (STEP) and OEM Partners Program.

The Enterprise Vault documentation set is shipped in the Enterprise Vault server

kit.

Comment on the documentationLet us know what you like and dislike about the documentation. Were you able to

find the information youneeded quickly? Was the information clearly presented?

1Chapter


20/652

Report errors and omissions, or tell us what you would find useful in future

versions of our guides and online help.

Please include the following information with your comment:

■ The title and product version of the guide you are commenting on

■ The topic (if relevant) you are commenting on

■ Your name

Email your comment to [email protected]. Please only use this address to

comment on product documentation.

We appreciate your feedback.

About this guideComment on the documentation

20

mailto:[email protected]:[email protected]


21/652

API updates

This chapter includes the following topics:

■ About API updates

■ Enterprise Vault 10.0.1

■ Enterprise Vault 10.0

■ Enterprise Vault 9.0 SP3









■ Enterprise Vault 2007 SP1, Enterprise Vault 7.0 SP3, and Enterprise Vault 6.0

SP5

■ Enterprise Vault 2007, Enterprise Vault 7.0 SP2, and Enterprise Vault 6.0 SP4


2Chapter


22/652

About API updatesThis chapter lists changes made to theAPIs, SDK, or this API manual, and advance

notice of future changes to Enterprise Vault APIs.

Enterprise Vault 10.0.1This section lists the changes and corrections in Enterprise Vault 10.0.1.

Table 2-1 Changes and corrections

Change detailsRef

Note the following information about dates in Enterprise Vault index

properties.

The supported date range in index properties has changed. The

supported range is now 1 January 1970 to 1 January 2038. In previous

releases the supported range was 1 January 1970 to 31 December2148.

In index search results, items that are indexed with date properties

earlier than 1 January 1970 are returned in the index search results,

but the retrieved date values defaults to 1 January 1970. Items that

are indexed with date prop

Documents

EV10 API Reference