IBM Document Manager API编程接口参考

2星需积分: 9 76 浏览量更新于2024-08-02 收藏 814KB PDF 举报

本资源是IBM Document Manager的官方文档，详细介绍了DB2 Document Manager Client Application Programming Interface (API)的参考版本8 Release 3，文档编号为SC18-9646-01。该文档适用于IBM DB2 Document Manager产品（产品号5724-H90）的第8版第3个发布，以及后续所有版本和修改，直到有新的版本说明。主要内容包括： 1. **关于本指南**：文档首先提供了对指南的整体概述，解释了它的目的和内容结构，以便读者快速定位所需的信息。这部分可能包含编写指南的目的、目标受众和预期读者应具备的基础知识。 2. **谁应该阅读**：指南针对的读者群体可能是DB2 Document Manager的开发人员、系统管理员、技术支持人员以及希望了解API如何与该产品互动的用户。这部分会根据读者的角色提供定制化的指导。 3. **如何使用**：文档详细说明了如何有效地查阅和利用API，包括目录结构、索引、查找特定功能的方法以及解决常见问题的途径。可能还会提到不同章节之间的关系和推荐的阅读顺序。 4. **安全设置指南**：文档强调了在使用API时的安全性，提供了关于如何设置安全环境的建议，如加密、访问控制和审计机制。此外，还会有专门的章节讲述如何选择和管理安全密码，以确保数据和系统的安全性。 5. **版权和使用限制**：最后，文档包含了版权信息和美国政府用户使用的限制，提醒读者在使用内容时必须遵守IBM的许可协议，并可能受GSA合同约束。通过阅读这份文档，用户可以深入理解如何通过DB2 Document Manager API进行客户端应用程序编程，优化操作效率，同时遵循最佳实践以保障数据和系统的安全性。对于任何与IBM Document Manager相关项目或维护工作的IT专业人员来说，这是一份不可或缺的技术参考资源。

endif

’ Select the desired items in the Desktop

oClient.SelectResults ( oItemDescriptors )

Creating a new item

This example shows how to create a new item.

’ Create an item object

set oItem = oLib.CreateItem ( "myClassName", "myStateName" )

’ Get the ItemProperties collection

set oItemProperties = oItem.ItemProperties

’ Set the values for the properties of interest

for each oItemProperty in oItemProperties

propertyName = oItemProperty.Name

if propertyName = "myProp1" then

oItemProperty.Value = "myVal1"

elseif propertyName = "myProp2" then

oItemProperty.Value = "myVal2"

elseif propertyName = "myProp3" then

oitemProperty.Value = "myVal3"

endif

’ Add the item to the library

oItem.Add ( "myFileContentPath" )

Performing a search

This example shows how to perform a search.

’ Create a search from the specified library object

set oSearch = oLib.CreateSearch ( dmSearchTypeCriteria )

’ Create a property criterion object

set oPropertyCriterion = Wscript.CreateObject ( "DMClientAPI.DMPropertyCriterion" )

’ Set the criterion

oPropertyCriterion.PropertyName = "myPropertyName"

oPropertyCriterion.PropertyValue = "myPropertyValue"

oPropertyCriterion.CompareOp = dmCompareOpEqual

’ Create a property criterion collection

set oPropertyCriteria = Wscript.CreateObject ( "DMClientAPI.DMPropertyCriteria" )

’ Add the criterion to the criteria collection

oPropertyCriteria.Add ( oPropertyCriterion )

’ Set the criteria in the search object

oSearch.PropertyCriteria = oPropertyCriteria

’ Perform the search

set oSearchResults = oSearch.Execute ( "myDMDisplayViewName" )

Retrieving an item from search results

This example shows how to retrieve an item from search results.

4 Client Application Programming Interface Reference

’ Get the search result items collection from the search results

set oSearchResultItems = oSearchResults.SearchResultItems

’ Choose the first item in the searchResultItems collection

set oSearchResultItem = oSearchResultItems.Item ( 1 )

’ Retrieve the item descriptor for the chosen item

set oItemDescriptor = oSearchResultsItem.ItemDescriptor

’ Retrieve the item from the library

set oItem = oLib.RetrieveItem ( oItemDescriptor )

Creating a compound document link

This example shows how to create a compound document link.

’ Create a link object, specifying the relationship type for the link

set oLink = oLib.CreateCompoundDocLink ( oParentItemDescriptor,

oChildItemDescriptor, dmLinkTypeParentChild )

’ Set the desired properties on the link

oLink.LinkCurrentChildVersionOnCheckin = TRUE

oLink.RetrieveCurrentChildVersion = TRUE

’ Add the link to the repository

oLink.Add ()

C++ programming considerations

The DB2 Document Manager client API can be used by programmers that are

writing applications in Microsoft Visual Basic, C, C++, or C#. The information in

this section is provided for C++ programmers. This section is not intended to be

comprehensive, but we hope that the hints and tips that are included here for

standard tasks will be useful.

Properties and methods

This reference guide presents the DB2 Document Manager client API in terms of

objects and collections, and their properties and methods. The format in which

properties and methods are documented will be most familiar to Microsoft Visual

Basic and VBScript programmers.

Method declarations

To see method declarations that are appropriate for C++ programmers, refer to the

type library that is stored in DdmClientApi.dll. For example, this guide includes

the following method declaration, with a documented return value of DMClient:

GetClient (Integer GetClientOptions)

The equivalent method declaration for C++ programmers looks like this:

HRESULT GetClient (int GetClientOptions, DMClient** Client)

Data types

To see property data types and method parameter data types that are appropriate

for C++ programmers, refer to the type library that is stored in DdmClientApi.dll.

For example, a ″String″ data type in Microsoft Visual Basic programs might be a

″BSTR*″ data type in C++.

Chapter 2. Using the DB2 Document Manager client API 5

Return values

If a method returns a value, that value is documented in the Returns section of the

method description. For example, as documented in this guide,

DMClientAPI.GetClient has an input parameter and returns a DMClient object. In

C++, a method that returns a value does so by using the last parameter of the

method. This means that, in the case of DMClientAPI.GetClient, the method has

one input parameter and returns the DMClient object in a second, output

parameter:

HRESULT GetClient (Long GetClientOptions, DMClient** Client)

Return codes

All DB2 Document Manager properties and methods return one of the following

codes:

S_OK The property or method call succeeded.

E_FAIL

The property or method call failed.

Tip: You should always test the value of the method’s return code when a

method returns.

Optional parameters

In C++, some parameters can be optional and others required, but the required

parameters must always come before the optional parameters. When you call a

method, you can choose not to provide values for the optional parameters. But if

you provide a value for any of the optional parameters, you must provide a value

of vtMissing for any of the other optional parameters that precede it and for which

you do not care to provide a value. You can use vtMissing in place of a default

parameter or for a parameter that you are not using.

Tip: The constant parameter vtMissing is available in later Microsoft Visual

C++ environments. If it is not available, you can define the same parameter by

creating a Variant of type VT_ERROR with the value

DISP_E_PARAMNOTFOUND.

For example, the Add method of the DMItem object has three optional parameters:

objDMItem.Add ( ContentFilePath, IndexContent, KeepLocalCopy )

v If you only want to provide a value for the first parameter, you can call the API

with just that one parameter. (You need not specify vtMissing for the other two

parameters.)

v If you want to provide a value for the second parameter, you must also provide

a value for the first parameter, even if that value is only vtMissing. (You can call

the API with just those two parameters; you need not specify vtMissing for the

last parameter.)

v If you want to provide a value for the third parameter, you must also provide

values for the first and second parameters, even if those values are only

vtMissing.

6 Client Application Programming Interface Reference

剩余85页未读，继续阅读

crazypeter2005

粉丝: 0
资源: 5

IBM Document Manager API编程接口参考

DMAPI-开源

IBM SPSS Modeler CRISP-DM指南（中文）.pdf

IBM i2的开发文档

如何与IBM Engineering Requirements Management DOORS Next API地址集成

Ibm v3700官方文档

IBM Engineering Requirements Management DOORS Next API地址

IBM econfig 安装配置官方文档

请提供IBM文档中关于并发限制的访问地址

请提供IBM官方文档中记录了JAS实例限制的访问地址

如何将GPT-4的API集成到你的Android应用中

最新资源