Kofax DM API Manuel d'utilisateur

DM API Reference GuideHummingbird Enterprise™ 2004

x%DELETE_PHYSICAL_FILES 345%DOCS_LIBRARY_NAME 346%DOCUMENT_NUMBER 348%EFFECTIVE_RIGHTS 350%ELAPSED_TIME 352%ENCAPSULATION_TYPE 354%FILTER_

80 CHAPTER 3PCDNetworkInfo Dim nNumRows As Long 'If program is now checking the top of Member 'list from the opening of the form..

DM API OBJECTS 81PCDNetworkInfo & “retrieve the Users Groups." End If Else 'This is the first time through. Do n

82 CHAPTER 3PCDNetworkInfo sUserID = TxtUserID.Text nResult = oIsMember.IsMemberOf( "%NI_NT", _ sDomainName, sUserID, sGroupNa

DM API OBJECTS 83PCDPropertyListPCDPropertyListPCDPropertyList is a Messenger object that allows you to store and manipulate a collection of prop

84 CHAPTER 3PCDPropertyListExampleThe following example shows how you can incorporate the functionality of the GetPropertyList object into an applica

DM API OBJECTS 85PCDPropertyListEnd Sub Private Sub cbListProperties_Click() Dim nResult As Long Dim nTotalElements As Integer nTota

86 CHAPTER 3PCDPropertyList For i = 1 To nTotalElements nResult = _ ValueForm.oValueFormProps.AddProperty( _ oGlobalPropertyList.

DM API OBJECTS 87PCDPropertyList oGlobalPropertyList.AddProperty( _ "Table Locks", vPropValue) 'I

88 CHAPTER 3PCDPropertyList Else MsgBox "CPU Property Addition has failed" End If End Sub Public oValueFormProps As New PCDProper

DM API OBJECTS 89PCDPropertyList oValueFormProps.GetPropertyValue( _ sSearchString) 'Report the value of the property. lb

xi%LOCK_FOR_CHECKOUT 403%LOOKUP_ID 404%MAKE_READ_ONLY 406%MAXDAYS 408%NUM_COMPONENTS 409%OBJECT_IDENTIFIER 410%OBJECT_TYPE_ID 412%O

90 CHAPTER 3PCDPropertyList'Note that this example retrieves each value 2 'times. Public oListFormProps As New PCDPropertyList Private Su

DM API OBJECTS 91PCDPropertyList Public nActiveProperty As Integer Public oDeleteProp As New PCDPropertyList Private Sub cbCancel_Click() Unlo

92 CHAPTER 3PCDPropertyList 'Determine number of rows in the PCDPropertyList. nTotalRows = oDeleteProp.GetSize() If nTotalRows > 0 Th

DM API OBJECTS 93PCDPropertyList nResult = oDeleteProp.NextProperty() Next i End If lstProperties.ListIndex = 0 nActiveProperty

94 CHAPTER 3PCDPropertyList Dim nResult As Long Dim nIndex As Long Dim nSize As Long Dim sPropName As String sPropName = txtPropertyName.

DM API OBJECTS 95PCDPropertyListGetPropertyValue GetSize NextProperty See the following properties:ErrDescription ErrNumber

96 CHAPTER 3PCDPropertyListsPCDPropertyListsThis object lets you work with a collection of PCDPropertyList objects.SyntaxPCDPropertyLists.methodOrPro

DM API OBJECTS 97PCDPutDoc PCDPutDocPCDPutDoc allows you to obtain and manage a set of PCDPutStream object pointers that your customized client a

98 CHAPTER 3PCDPutDoc Dim VersionID As Long Dim TotalFileSize As Long Dim TotalBytesWritten As Long Dim Buffread As Long 'Set bdata rid

DM API OBJECTS 99PCDPutDoc objPutDoc.AddSearchCriteria _ "%TARGET_LIBRARY", Library objPutDoc.AddSearchCriteria _ &quo

xii%RECENTACTIVITYTIME 454%RELATED_REMOTE_LIBS 455%REMOVE_READ_ONLY 456%RENDITION_TYPE 459%RIGHT8 461%RIGHT9 463%SCORE_GRAPHIC 465%SCORE

100 CHAPTER 3PCDPutDoc Else TotalFileSize = TotalBytesWritten End If Get #1, , bdata objPutStream.Write

DM API OBJECTS 101PCDPutDocRelated ItemsSee the following methods: See the following properties:ErrDescription ErrNumber AddSearchCriteria Exe

102 CHAPTER 3PCDPutStreamPCDPutStreamUse PCDPutStream to provide users with the ability to write the contents of physical files to disk. SyntaxPCDPut

DM API OBJECTS 103PCDRecentDocPCDRecentDocUse the PCDRecentDoc object to retrieve recently edited documents from your DM Repository.SyntaxPCDRece

104 CHAPTER 3PCDRecentDocRelated ItemsSee the following methods: See the following properties:ErrDescription ErrNumber AddOrderByProperty AddRetur

DM API OBJECTS 105PCDSearchPCDSearchPCDSearch provides the user with the ability to enter criteria to execute a search of the available document

106 CHAPTER 3PCDSearchSee the following properties:ErrDescription ErrNumber

DM API OBJECTS 107PCDSQLPCDSQLThe PCDSQL object allows direct access to SQL tables that support the DM document management system. Caution: The P

108 CHAPTER 3PCDSQLthat allows the document security token (DST) to be shared throughout the entire application.'These are the Project-wide Glob

DM API OBJECTS 109PCDSQL'This will be shared throughout this form. Public oDIC As New DocInternalClass Private Sub cbNextKey_Click() Next

xiii%VISIBLE 507

110 CHAPTER 3PCDSQL Dim sBuffer As String Dim oLogin As New PCDLogin Dim nResult As Long Dim sTempBuf As String 'Login process. nR

DM API OBJECTS 111PCDSQL'because without the Document Security Token 'being set within the object, the verification of 'the '

112 CHAPTER 3PCDSQL nResult = oSelectSQL.ReleaseResults() Unload SelectForm End Sub Private Sub cbSelect_Click() 'Local Variable Dec

DM API OBJECTS 113PCDSQL oSelectSQL.GetColumnValue(j)) Next j Next i End Sub Private Sub Form_Load() 'Set

114 CHAPTER 3PCDSQLPublic oUpdateSQL As New PCDSQL Private Sub cbCancel_Click() Dim nResult As Long 'Release the result set for this

DM API OBJECTS 115PCDSQL Dim nResult As Long Dim nRowCount As Long 'Determine which row is being updated. 'Then, load the dat

116 CHAPTER 3PCDSQL 'Set the Library. If nResult = 0 Then nResult = oUpdateSQL.SetLibrary("MyNewLibrary") Else MsgBox (&q

DM API OBJECTS 117PCDSQL txtFullName.Text = oUpdateSQL.GetColumnValue(2) End Sub Private Sub lstUserIDs_Click() Dim nListIndex As Long

118 CHAPTER 3PCDSQLDim sDST As String Dim oDSTDIC As New DocInternalClass Dim oDSTLogin As New PCDLogin Public oDSTSQL As New PCDSQL Private Sub cbC

DM API OBJECTS 119PCDSQL & “DOCSADM.PROFILE") If nResult = 0 Then NextRowForm.sNRDST = oDSTDIC.GetDST() NextRowForm.Sh

xiv

120 CHAPTER 3PCDSQL Public oNRSQL As New PCDSQL Public nNumRows As Long Public nNumCols As Long Public nRowsViewed As Long Private Sub cbCancel_Cli

DM API OBJECTS 121PCDSQL End Sub Private Sub cbNextRow_Click() Dim nResult As Long 'Increment the nRowsViewed count. nRowsVie

122 CHAPTER 3PCDSQL If nResult = 0 Then nNumRows = oNRSQL.GetRowCount() 'If there are more than one row then lets do it. If nN

DM API OBJECTS 123PCDSQLPublic oNextKey As New PCDSQL Private Sub cbCancel_Click() Unload NextKeyForm End Sub Private Sub cbNextKey_Click()

124 CHAPTER 3PCDSQLRelated ItemsSee the following methods: See the following properties:ErrDescription ErrNumber Execute GetColumnCount GetColumn

DM API OBJECTS 125PCDTrusteeListPCDTrusteeListUse PCDTrusteeList to manipulate the trustee list associated with DM.SyntaxPCDTrusteeList.methodOrP

126 CHAPTER 3PCDTrusteeList

Chapter 4DM API METHODS AND PROPERTIES 127DM API Methods and PropertiesIn This ChapterThis chapter describes the methods and properties associate

128 CHAPTER 4AddLoginAddLoginUse this method to set the logon information that gets passed to the DM Server. The DM Server authenticates the logon in

DM API METHODS AND PROPERTIES 129AddLogin'dimensioned as constants. Const iLibraryLogin As Integer = 0 Const iNetWareBindery As Intege

xvPrefaceAbout This GuideThis guide describes the application programming interface (API) that is available as part of DM. It identifies each of

130 CHAPTER 4AddLogin 'DM API supports. MyLoginType.LIBRARY_LOGIN = 0 MyLoginType.NETWORK_BINDERY = 1 MyLoginType.NETWORK_NDS = 2

DM API METHODS AND PROPERTIES 131AddLoginEnd Sub . . .Related ItemsSee the following objects:PCDLogin PCDGetLoginLibs See the following methods

132 CHAPTER 4AddLoginLicensedAddLoginLicensedThe “Allow SQL Passthrough” setting in the DM system parameter settings dialog can be used to deny acces

DM API METHODS AND PROPERTIES 133AddLoginLicensedParametersUsageBefore you do a call to AddLoginLicensed, you need to get the logon libraries ava

134 CHAPTER 4AddLoginLicensed strMyDomain, strMyUserID, _ strMyPassword, strAppID, _ strLicenseKey

DM API METHODS AND PROPERTIES 135AddOrderByPropertyAddOrderByPropertyAddOrderByProperty allows you to set the order that search results are retur

136 CHAPTER 4AddOrderByProperty'Create the search object. Dim pSearch As New PCDSearch 'Set the document security token (DST). pSearch.Set

DM API METHODS AND PROPERTIES 137AddPropertyAddPropertyUse this method to add a property/value pair to a property value list.SyntaxPCDPropertyLis

138 CHAPTER 4AddReturnMetaPropertyAddReturnMetaPropertyThe AddReturnMetaProperty method allows you to retrieve information about the data requested i

DM API METHODS AND PROPERTIES 139AddReturnMetaPropertyParameter ReturnsReturns a VARIANT return value that contains the value of the requested p

xvi CHAPTER 3Documentation ConventionsThis book uses the following fonts and styles to indicate different types of information. Related Documentation

140 CHAPTER 4AddReturnPropertyAddReturnProperty Use this method to add a property to the list of objects that you want a search to return to you. No

DM API METHODS AND PROPERTIES 141AddReturnPropertypSearch.SetDST( strDST ) 'Add the Library you want to search. pSearch.AddSearchLib( "

142 CHAPTER 4AddSearchCriteriaAddSearchCriteriaUse this method to add a property name with search criteria to the search. SyntaxPCDGetDoc.AddSearchCr

DM API METHODS AND PROPERTIES 143AddSearchCriteriaDST = pClient.GetDST() 'Now that you have the DST, create a search object. pSearch = Serv

144 CHAPTER 4AddSearchCriteriaRelated ItemsSee the following objects:PCDGetDoc PCDLookup PCDPutDoc PCDRecentDoc PCDSearch See the following prop

DM API METHODS AND PROPERTIES 145AddSearchLibAddSearchLibUse this method to add a library name to the list of libraries to search. Your search wi

146 CHAPTER 4AddSearchLib 'Pass the DST to the search object. pSearch.SetDST( DST ) 'Get the search library from the form. searchLib = txt

DM API METHODS AND PROPERTIES 147AddTrusteeAddTrusteeUse this method to add a trustee to the trustee list. If there is already a trustee in the l

148 CHAPTER 4AddTrusteeBeginIter DeleteTrustee GetCurrentTrusteeFlags GetCurrentTrusteeName GetCurrentTrusteeRights GetSize GetTrusteeIndex Get

DM API METHODS AND PROPERTIES 149AddUserFilterCriteriaAddUserFilterCriteriaUse this method to add a property name with user filter criteria to a

xviiProfessional ServicesHummingbird’s Professional Services’ consultants and educators successfully design, create, and implement powerful integ

150 CHAPTER 4BeginGetBlockBeginGetBlockUse this method to tell the object that you are beginning a block of “Get” operations so that it will hold the

DM API METHODS AND PROPERTIES 151BeginIterBeginIterUse this method to position the current pointer to the first position in a list. This method b

152 CHAPTER 4BeginIterErrDescription ErrNumber

DM API METHODS AND PROPERTIES 153BytesReadBytesReadThis property is always set during a Read operation. It contains the number of bytes returned

154 CHAPTER 4BytesWrittenBytesWrittenThis property is always set during a Write operation. It contains the number of bytes written to disk by the cal

DM API METHODS AND PROPERTIES 155ClearOrderByPropertiesClearOrderByPropertiesUse this method to clear properties used to order results from a loo

156 CHAPTER 4ClearUserFilterCriteriaClearUserFilterCriteriaUse this method to clear user filter criteria from a lookup. SyntaxPCDLookup.ClearUserFilt

DM API METHODS AND PROPERTIES 157CloneCloneThis method clones a duplicate copy of the current PCDEnumPropertyLists object.SyntaxPCDEnumPropertyLi

158 CHAPTER 4ColumnCountColumnCountUse this method to return the number of columns in the return data. This will always be equal to or greater than t

DM API METHODS AND PROPERTIES 159CreateCreateUse this method to create the object that has been identified by the SetObjectType method.SyntaxPCDD

xviii CHAPTER 3Where to Go for InformationOn the Web Our Web site at www.hummingbird.com/support/dkm/ carries the most up-to-date information about H

160 CHAPTER 4DeleteDeleteUse this method to delete the DM object described by the information that has been set.SyntaxPCDDocObject.Delete()ReturnsRet

DM API METHODS AND PROPERTIES 161DeletePropertyDeletePropertyUse this method to delete a property from the property list based on its index (rela

162 CHAPTER 4DeletePropertyAddProperty BeginIter GetCurrentPropertyName GetCurrentPropertyValue GetPropertyIndex NextProperty See the following prope

DM API METHODS AND PROPERTIES 163DeleteTrusteeDeleteTrusteeUse this method to delete from the list of trustees a trustee at a given offset. Synta

164 CHAPTER 4EndGetBlockEndGetBlockEndGetBlock informs the server that you finished retrieving a series of items. This allows the DM API to release t

DM API METHODS AND PROPERTIES 165ErrDescriptionErrDescriptionThis property provides a text description of the status from the last call. All DM A

166 CHAPTER 4ErrNumberErrNumberThis property provides a numeric status that identifies any error condition resulting from the last call.SyntaxPCDErro

DM API METHODS AND PROPERTIES 167ExecuteExecuteThe Execute method is supported for use in many API objects. After you set any necessary criteria

168 CHAPTER 4ExecuteExampleThis reference guide contains many examples that show the use of the Execute method, starting with the The Logon Process s

DM API METHODS AND PROPERTIES 169FetchFetchUse this method to retrieve information about an object. SyntaxPCDDocObject.Fetch()ReturnsReturns an H

xix4 Follow the on-screen instructions and install the program. When complete, exit the DM Product Line Installation menu.To access the entire DM

170 CHAPTER 4FetchTrusteesFetchTrusteesUse this method to fetch trustees from the DM Server. SyntaxPCDDocObject.FetchTrustees()ReturnsReturns an HRES

DM API METHODS AND PROPERTIES 171FetchTrustees Set objDOC = CreateObject( _ "PCDClient.PCDDocObject") 'Create the pro

172 CHAPTER 4FetchTrustees 'Does the document have security? ' 0 = no; 1 = yes LDefaultRights = _ o

DM API METHODS AND PROPERTIES 173FetchTrustees & "permission to edit the security of " _ & "this document:

174 CHAPTER 4GetAliasListGetAliasListUse this method to get a pointer to the PCDNetAliasList object that contains a list of all the network aliases t

DM API METHODS AND PROPERTIES 175GetAtGetAtUse this method to get a Library name string at a specific index in the list of logon libraries.Syntax

176 CHAPTER 4GetColumnCountGetColumnCountThe GetColumnCount method retrieves the number of SQL columns in a result set. It references the current res

DM API METHODS AND PROPERTIES 177GetColumnNameGetColumnNameThis method retrieves the name of the specified column in the current SQL result set.

178 CHAPTER 4GetColumnValueGetColumnValueThis method retrieves the data contents of the specified column in the current SQL result set. SyntaxPCDSQL.

DM API METHODS AND PROPERTIES 179GetCurrentPropertyNameGetCurrentPropertyNameUse this method to get the name of the property to which the current

DM API Reference GuideVersion: 5.1.0.5Copyright © 1998-2004 Hummingbird Ltd. All rights reserved.Electronic Publication Date: April 2004Hummingbird

xx CHAPTER 3Training Hummingbird’s Education Services offers courses at authorized training centers worldwide. For more information or to register fo

180 CHAPTER 4GetCurrentPropertyValueGetCurrentPropertyValueUse this method to get the value of the property to which the current property pointer poi

DM API METHODS AND PROPERTIES 181GetCurrentTrusteeFlagsGetCurrentTrusteeFlagsUse this method in a BeginIter/NextTrustee loop to get the trustee f

182 CHAPTER 4GetCurrentTrusteeNameGetCurrentTrusteeNameUse this method in a BeginIter/NextTrustee loop to get the trustee name for the current entry

DM API METHODS AND PROPERTIES 183GetCurrentTrusteeRightsGetCurrentTrusteeRightsUse this method in a BeginIter/NextTrustee loop to get the trustee

184 CHAPTER 4GetDBVendorGetDBVendorThe GetDBVendor method retrieves the numeric identifier associated with the SQL database software in use with the

DM API METHODS AND PROPERTIES 185GetDomainListGetDomainListThis method allows you to retrieve a list of all other network domains that are access

186 CHAPTER 4GetDomainListErrDescription ErrNumber

DM API METHODS AND PROPERTIES 187GetDOCSUserNameGetDOCSUserNameAfter calling PCDLogin.Execute, use this method to determine the DM USER_ID with w

188 CHAPTER 4GetDSTGetDSTUse this method to get the document security token (DST) that the server returns after a call to the Execute method of the P

DM API METHODS AND PROPERTIES 189GetFailedLoginListGetFailedLoginListUse this method to get a PCDNetAliasList object pointer to an object contain

Chapter 1THE DM ARCHITECTURE 1The DM ArchitectureIn This ChapterThis chapter provides an overview of the DM functionality, illustrating how the m

190 CHAPTER 4GetFailedLoginListSee the following properties:ErrDescription ErrNumber

DM API METHODS AND PROPERTIES 191GetGroupListGetGroupListThe GetGroupList method populates the result set with a list of the various groups that

192 CHAPTER 4GetGroupListErrDescription ErrNumber

DM API METHODS AND PROPERTIES 193GetGroupMembersGetGroupMembersThis method retrieves the user IDs that are present in the specified group. There

194 CHAPTER 4GetGroupMembersSee the following properties:ErrDescription ErrNumber

DM API METHODS AND PROPERTIES 195GetLoginLibraryGetLoginLibraryUse this method to retrieve the name of the DM library where the user is currently

196 CHAPTER 4GetMetaPropertyValueGetMetaPropertyValueUse this method to get the value of a property from metadata that is returned when a search or l

DM API METHODS AND PROPERTIES 197GetMetaPropertyValue• %Visible is a flag indicating whether or not this Lookup list box column should be display

198 CHAPTER 4GetMetaRowsFoundGetMetaRowsFoundUse this method to identify the total number of rows of metadata that are returned when your search or l

DM API METHODS AND PROPERTIES 199GetMetaRowsFoundRelated ItemsSee the following objects:PCDLookup PCDRecentDoc PCDSearch See the following proper

2 CHAPTER 1The DM Multi-Tier ArchitectureThe DM Multi-Tier ArchitectureDM is an application that runs on Windows NT/2000/XT Pro systems. As shown in

200 CHAPTER 4GetNextKeyGetNextKeyGetNextKey generates the next numeric value for a primary key column in the SQL database. This is true for all SQL d

DM API METHODS AND PROPERTIES 201GetNextKeyMost of the tables in the DM SQL database have a SYSTEM_ID column as their primary key. DM generates p

202 CHAPTER 4GetNextKeyfollowing exceptions: —The SYSTEMKEY column is maintained in Oracle as the SEQSYSTEMKEY sequence key.—Other primary keys have

DM API METHODS AND PROPERTIES 203GetPrimaryGroupGetPrimaryGroupUse this method to get the DM GROUP_ID that identifies the user’s primary group. Y

204 CHAPTER 4GetPropertiesGetPropertiesUse this method to create a PCDPropertyList object and to copy the properties in the PCDDocObject’s internal l

DM API METHODS AND PROPERTIES 205GetPropertyGetPropertyUse this method to get the value of a property. This value may have been previously set wi

206 CHAPTER 4GetPropertyIndexGetPropertyIndexUse this method to get the property index of a named property. Check the ErrNumber property after callin

DM API METHODS AND PROPERTIES 207GetPropertyIndexExampleThis sample code demonstrates the GetPropertyIndex call on the PCDPropertyList object. Th

208 CHAPTER 4GetPropertyIndex nIndex = _ oIndexFormProps.GetPropertyIndex( _ sPropName )

DM API METHODS AND PROPERTIES 209GetPropertyValueGetPropertyValueUse this method to get the value of the named property from the current row in t

THE DM ARCHITECTURE 3DM FunctionalityThe DM Server is a transaction server, similar to Microsoft SQL Server. The DM Server manages database conne

210 CHAPTER 4GetPropertyValuePCDGetDoc PCDGetForm PCDGetStream PCDPropertyList PCDPropertyLists PCDPutDoc PCDPutStream PCDRecentDoc PCDSearch

DM API METHODS AND PROPERTIES 211GetPropertyValueByIndexGetPropertyValueByIndexUse this method to get the value of a return property based on its

212 CHAPTER 4GetPropertyValueByIndexErrDescription ErrNumber

DM API METHODS AND PROPERTIES 213GetReturnPropertiesGetReturnPropertiesUse this method to get a copy of the list of properties that the server wi

214 CHAPTER 4GetReturnPropertiesNextProperty SetProperty SetReturnProperties See the following properties:ErrDescription ErrNumber

DM API METHODS AND PROPERTIES 215GetReturnPropertyGetReturnPropertyUse this method to get the value of a return property. SyntaxPCDDocObject.GetR

216 CHAPTER 4GetRowCountGetRowCountUse the GetRowCount method to determine the number of rows that a result data set returns.SyntaxPCDNetworkInfo.Get

DM API METHODS AND PROPERTIES 217GetRowsAffectedGetRowsAffectedThis method reports the number of rows in the SQL database that were affected by t

218 CHAPTER 4GetRowsFoundGetRowsFoundUse this method to get the number of rows found as a result of a search operation. SyntaxPCDGetDoc.GetRowsFound(

DM API METHODS AND PROPERTIES 219GetRowsFoundPCDSearch See the following properties:ErrDescription ErrNumber

Document Security TokensA document security token (DST) is initially constructed by DM when a user logs on via a client application to the server and

220 CHAPTER 4GetSearchCriteriaGetSearchCriteriaUse this method to get a PCDPropertyList object pointer to a copy of the list of search criteria that

DM API METHODS AND PROPERTIES 221GetSizeGetSizeUse this method to get the number items in a list. For example, you can use GetSize to request the

222 CHAPTER 4GetSizeSee the following properties:ErrDescription ErrNumber

DM API METHODS AND PROPERTIES 223GetSQLErrorCodeGetSQLErrorCodeThis method retrieves the native SQL error code as returned by the library’s datab

224 CHAPTER 4GetSQLErrorCodeExampleThe Example in PCDSQL illustrates the use of the GetSQLErrorCode.Related ItemsSee the PCDSQL object.See the follow

DM API METHODS AND PROPERTIES 225GetTrusteeGetTrusteeUse this method to get the trustee rights value for the trustee you specify.SyntaxPCDDocObje

226 CHAPTER 4GetTrusteeSee the following properties:ErrDescription ErrNumber

DM API METHODS AND PROPERTIES 227GetTrusteeIndexGetTrusteeIndexUse this method to locate the index location of a trustee in a list of trustees. S

228 CHAPTER 4GetTrusteeIndexErrDescription ErrNumber

DM API METHODS AND PROPERTIES 229GetTrusteeRightsGetTrusteeRightsUse this method to get the trustee rights for an entry in a trustee list at an i

THE DM ARCHITECTURE 5Types of DM ObjectsThe DM Object Model consists of Distributed Component Object Model (DCOM) objects that are exposed via DM

230 CHAPTER 4GetTrusteesGetTrusteesOnce a list of trustees has been retrieved from the SQL database by use of FetchTrustees, use this method to popul

DM API METHODS AND PROPERTIES 231GetUserFullNameGetUserFullNameThis method retrieves the full name of the user from the network operating system.

232 CHAPTER 4GetUserFullNameRelated ItemsSee the PCDNetworkInfo object.See the GetValue method.See the following properties:ErrDescription ErrNumber

DM API METHODS AND PROPERTIES 233GetUserGroupsGetUserGroupsThis method allows you to load a result set with the security groups that include the

234 CHAPTER 4GetUserGroupsExampleThe Example in the discussion of the PCDNetworkInfo object shows how you can use this method.Related ItemsSee the PC

DM API METHODS AND PROPERTIES 235GetUserListGetUserListThis method retrieves the set of user ID values that exist within the network domain that

236 CHAPTER 4GetUserListExampleThe Example in the discussion of the PCDNetworkInfo object shows how you can use this method.Related ItemsSee the PCDN

DM API METHODS AND PROPERTIES 237GetValueGetValueThe GetValue method retrieves the next value from the current result set. SyntaxPCDNetworkInfo.G

238 CHAPTER 4GrantRightGrantRightUse this method to set the named bit in the rights mask for the specified user or group. SyntaxPCDDocObject.GrantRig

DM API METHODS AND PROPERTIES 239GrantRightThe following QuickSearch rights are supported: Related ItemsSee the PCDDocObject object.See the foll

6 CHAPTER 1Types of DM Objects• Query (read only), which is used for search, Quick Retrieve, and lookups.• PCDDocObject (read/write), which implement

240 CHAPTER 4HasRightHasRightUse this method to determine if the specified user or group rights mask permits the right you specify. SyntaxPCDDocObjec

DM API METHODS AND PROPERTIES 241HasRightThe following QuickSearch rights are supported: ExampleThe Example in the discussion of the FetchTruste

242 CHAPTER 4IsEmptyIsEmptyUse this method to check whether an empty document was uploaded. SyntaxPCDASPFileUpload.IsEmpty()ReturnsIsEmpty returns a

DM API METHODS AND PROPERTIES 243IsMemberOfIsMemberOfThis method reports whether or not a user ID is a member of the network group that you speci

244 CHAPTER 4IsMemberOfa call to NextRow returns FALSE. No results are returned if either the Domain name or the Group name is blank.ExampleSee the E

DM API METHODS AND PROPERTIES 245NewEnumNewEnumThis method provides standard-style C++ COM Enum access to the object.SyntaxPCDPropertyLists.NewEn

246 CHAPTER 4NextNextThis method returns PCDPropertyList items from the PCDPropertyLists object. You specify the number of items that you want return

DM API METHODS AND PROPERTIES 247NextMetaRowNextMetaRowUse this method to increment the current pointer in the metadata results set. SyntaxPCDLoo

248 CHAPTER 4NextPropertyNextPropertyUse this method to increment the internal pointer for the current property list so it points to the next propert

DM API METHODS AND PROPERTIES 249NextRowNextRowThis method increments the current row pointer.SyntaxPCDGetDoc.NextRow()PCDLookup.NextRow()PCDNetw

THE DM ARCHITECTURE 7The Logon Process• PCDError• PCDGetLoginLibs• PCDLogin• PCDNetAliasListDM Query Objects Query objects are used to search the

250 CHAPTER 4NextRowPCDPutDoc PCDRecentDoc PCDSearch PCDSQL See the following methods:Execute GetMetaPropertyValue GetMetaRowsFound GetPropertyValu

DM API METHODS AND PROPERTIES 251NextTrusteeNextTrusteeUse this method to iterate through the trustees in the trustee list. SyntaxPCDTrusteeList.

252 CHAPTER 4OnEndPageOnEndPageThe Active Server Pages (ASP) engine calls this method to clean up ASP objects.SyntaxPCDASPFileUpload.OnEndPage() Caut

DM API METHODS AND PROPERTIES 253OnStartPageOnStartPageThe Active Server Pages (ASP) engine calls this method to initialize pointers to ASP objec

254 CHAPTER 4ReadReadUse this method to read binary data from a physical file.SyntaxPCDGetStream.Read( lngBytes, [ lngBytesRead ] )ParametersReturnsR

DM API METHODS AND PROPERTIES 255ReleaseResultsReleaseResultsUse this method to release the results that are currently held in memory as a result

256 CHAPTER 4ResetResetThis method resets the PCDEnumPropertyLists object’s pointer to the first entry in the list of PCDPropertyList objects in the

DM API METHODS AND PROPERTIES 257RevokeRightRevokeRightUse this method to turn off a named bit in the supplied rights mask.SyntaxPCDDocObject.Rev

258 CHAPTER 4RevokeRightThe following QuickSearch rights are supported: ReturnsReturns an integer that contains the rights mask as it exists after t

DM API METHODS AND PROPERTIES 259SeekSeekUse this method to position the file’s current position pointer to a specific byte offset within the phy

8 CHAPTER 1The Logon ProcessGetting a List of Available LibrariesThe following example displays a list of libraries managed by the DM Server that the

260 CHAPTER 4SetChunkFactorSetChunkFactorThis method sets the number of rows to retrieve from the server results set when a SQL call is made. The def

DM API METHODS AND PROPERTIES 261SetChunkFactorErrDescription ErrNumber

262 CHAPTER 4SetCompleteSetCompleteFor languages such as JavaScript and VBScript that do not give the user explicit control over when an interface is

DM API METHODS AND PROPERTIES 263SetDSTSetDSTUse this method to set the document security token (DST) that will be used in processing the search

264 CHAPTER 4SetDSTbeen granted to you. The DST can be used across multiple DM libraries.ExampleThe SetDST method is used in many examples throughout

DM API METHODS AND PROPERTIES 265SetLibrarySetLibraryThis method sets the DM library that is to be used with the current instance of the PCDSQL o

266 CHAPTER 4SetLookupIdSetLookupIdUse this method to set the lookup form that you want to process. Similar to searches, lookups are controlled by fo

DM API METHODS AND PROPERTIES 267SetLookupIdErrDescription ErrNumber

268 CHAPTER 4SetMaxRowsSetMaxRowsUse this method to set the maximum number of rows to be returned by your lookup or search. SyntaxPCDLookup.SetMaxRow

DM API METHODS AND PROPERTIES 269SetMaxRowsErrDescription ErrNumber

THE DM ARCHITECTURE 9The Logon Process If (opOK) Then libname = Libs.GetAt(i) opOK = opOK And Libs.ErrNumber = 0 If i = 0 Th

270 CHAPTER 4SetMetaRowSetMetaRowUse this method to set the pointer to the current metadata row in the results set to a specific row number. SyntaxPC

DM API METHODS AND PROPERTIES 271SetMetaRowSee the following properties:ErrDescription ErrNumber

272 CHAPTER 4SetObjectTypeSetObjectTypeUse this method to set the object type. For PCDDocObject and PCDGetForm the object is a form available to the

DM API METHODS AND PROPERTIES 273SetObjectTypePCDPropertyLists See the following methods:Create Fetch Update See the following properties:Err

274 CHAPTER 4SetOptionsSetOptionsThis method allows you to set recursion and level options for items in property list collections.SyntaxPCDPropertyLi

DM API METHODS AND PROPERTIES 275SetOptionsRelated ItemsSee the following objects:PCDPropertyList PCDPropertyLists See the following properties

276 CHAPTER 4SetPropertiesSetPropertiesUse this method to set an object with a collection of properties. Any previously set properties are deleted.Sy

DM API METHODS AND PROPERTIES 277SetPropertySetPropertyUse this method to set a property to be used with a Create, Execute, or Update method. If

278 CHAPTER 4SetPropertyErrDescription ErrNumber

DM API METHODS AND PROPERTIES 279SetReturnPropertiesSetReturnPropertiesUse this method to set PCDRecentDoc or PCDSearch objects with a collection

iiiContentsPrefaceAbout This Guide xvWho Should Read This Guide xvHow This Guide Is Organized xvDocumentation Conventions xviRelated Docu

10 CHAPTER 1The Logon Process Dim lim As Long Dim LoginType As Integer Dim emsg As String If (NetworkType = "Network Bindery") Th

280 CHAPTER 4SetRowSetRowUse this method to set the row pointer in the results set to a specific row.Syntax PCDGetDoc.SetRow( lngRowNbr )PCDLookup.

DM API METHODS AND PROPERTIES 281SetRowPCDGetDoc PCDLookup PCDPutDoc PCDRecentDoc PCDSearch See the following methods:GetColumnValue GetProperty

282 CHAPTER 4SetSearchCriteriaSetSearchCriteriaUse this method to set the search criteria to be used in the current search.SyntaxPCDGetDoc.SetSearchC

DM API METHODS AND PROPERTIES 283SetSearchCriteriaPCDSearch See the following methods:AddSearchCriteria GetSearchCriteria See the following prope

284 CHAPTER 4SetSearchObjectSetSearchObjectUse this method to identify the form that you want to use to process the specified operation. SyntaxPCDG

DM API METHODS AND PROPERTIES 285SetSearchObjectPCDRecentDoc PCDSearch See the following properties:ErrDescription ErrNumber

286 CHAPTER 4SetTargetPropertySetTargetPropertyUse this method to set the target property of a lookup.SyntaxPCDLookup.SetTargetProperty( strTargetPro

DM API METHODS AND PROPERTIES 287SetTargetPropertyErrDescription ErrNumber

288 CHAPTER 4SetTrusteeSetTrusteeUse this method to set a trustee value in a trustee list. If the trustee name and flags match an existing entry in t

DM API METHODS AND PROPERTIES 289SetTrusteeSetTrustees See the following properties:ErrDescription ErrNumber

THE DM ARCHITECTURE 11DM Search Transactions txtPassword.SelStart = 0 txtPassword.SelLength = Len(txtPassword.Text) End If 'Du

290 CHAPTER 4SetTrusteesSetTrusteesUse this method to copy all the trustee entries from a PCDTrusteeList object into the internal trustee list for th

DM API METHODS AND PROPERTIES 291SetTrusteesErrDescription ErrNumber

292 CHAPTER 4SetTrusteeRightsSetTrusteeRightsUse this method to update the Trustee rights for a trustee at a given offset in the trustee list.SyntaxP

DM API METHODS AND PROPERTIES 293SkipSkipThis method skips PCDPropertyList objects in the PCDPropertyLists collection. You specify how many objec

294 CHAPTER 4UnitNameUnitNameUse this method to get unit name of an entry in a PCDLogin list that a PCDNetAliasList object is accessing.SyntaxPCDNetA

DM API METHODS AND PROPERTIES 295UnitTypeUnitTypeUse this method to get unit type of an entry in a PCDLogin list that a PCDNetAliasList object is

296 CHAPTER 4UnitTypeUnitName UserName See the following properties:ErrDescription ErrNumber

DM API METHODS AND PROPERTIES 297UpdateUpdateThis method updates a PCDDocObject using the information that has previously been set by other metho

298 CHAPTER 4UpdateTrusteesUpdateTrusteesUse this method to update trustee information for a PCDDocObject object.SyntaxPCDDocObject.UpdateTrustees()R

DM API METHODS AND PROPERTIES 299UserNameUserNameUse this method to get user name of an entry in a PCDLogin list that a PCDNetAliasList object is

12 CHAPTER 1DM Search Transactions3 The DM Server does the following:— Captures search criteria, and immediately returns a “no results” message to th

300 CHAPTER 4WriteWriteUse this method to write binary data to a physical file. SyntaxPCDPutStream.Write( vntData, lngBytes )ParametersReturnsReturns

Chapter 5DM API TOKENS 301DM API TokensIn This ChapterThis chapter presents an alphabetical list of DM tokens. Each entry discusses the syntax, u

302 CHAPTER 5%ADD_ATTACHMENT%ADD_ATTACHMENTThis token is used with the %VERSION_DIRECTIVE token to add an attachment. See %VERSION_DIRECTIVE for furt

DM API TOKENS 303%ATTACHMENT_ID%ATTACHMENT_IDThis token is used by the Update method that PCDDocObject supports to add an attachment to the docum

%CHECKIN_DATEThis token is used in the Update method that the PCDDocObject objec t supports when the object is being checked out or locked. SyntaxPCDD

DM API TOKENS 305%CHECKOUT_COMMENT%CHECKOUT_COMMENTThis token is used in the Update method that the PCDDocObject object supports to specify the c

306 CHAPTER 5%CONTENT%CONTENTThis token is used to retrieve a stream for the content of the document. It can also be used to update the document.Synt

DM API TOKENS 307%CONTENT 'Report the total components (or rows). iCount = pGetDoc.GetReturnValue(%NUM_COMPONENTS) MsgBox(“The totoal number

308 CHAPTER 5%CONTENTS_AFTER_ITEM%CONTENTS_AFTER_ITEMThis token is used in conjunction with %CONTENTS_DIRECTIVE to specify that a folder should be mo

DM API TOKENS 309%CONTENTS_AFTER_ITEMCONTENTS_MOVE_AFTER") 'Update the document. pDocObject.Update() 'Check for errors. checkErr

THE DM ARCHITECTURE 13DM Search Transactionsoperation. The default is 10. You do not need to repeat the execution of the search to get the next c

310 CHAPTER 5%CONTENTS_COPY_CONTENTS%CONTENTS_COPY_CONTENTSThis token is used in conjunction with %CONTENTS_DIRECTIVE to specify that a folder’s cont

DM API TOKENS 311%CONTENTS_COPY_CONTENTS'Set the target folder. pDocObject.SetProperty("%CONTENTS_DST_PARENT", tarFolderNum) &apo

312 CHAPTER 5%CONTENTS_DIRECTIVE%CONTENTS_DIRECTIVEThis token is used to manipulate the content of the folder. The following operations are supported

DM API TOKENS 313%CONTENTS_DIRECTIVESee the following tokens:%CONTENTS_COPY_CONTENTS%CONTENTS_MOVE_AFTER%CONTENTS_MOVE_DOWN%CONTENTS_MOVE_TO_TOP%

314 CHAPTER 5%CONTENTS_ITEM%CONTENTS_ITEMThis token identifies the system ID that identifies the object that is the primary subject of the current op

DM API TOKENS 315%CONTENTS_ITEM%CONTENTS_MOVE_DOWN %CONTENTS_MOVE_TO_TOP %CONTENTS_MOVE_UP

316 CHAPTER 5%CONTENTS_MOVE_AFTER%CONTENTS_MOVE_AFTERThis token is used in conjunction with %CONTENTS_DIRECTIVE to specify that a folder should be re

DM API TOKENS 317%CONTENTS_MOVE_AFTER'Specify the place. pDocObject.SetProperty("%CONTENTS_AFTER_ITEM", afterSystemID) 'Set

318 CHAPTER 5%CONTENTS_MOVE_DOWN%CONTENTS_MOVE_DOWNUse this token in conjunction with %CONTENTS_DIRECTIVE to move a folder down by one position.Synta

DM API TOKENS 319%CONTENTS_MOVE_DOWN"%CONTENTS_MOVE_DOWN") 'Process the update. pDocObject.Update() 'Check for error(s). ch

14 CHAPTER 1DM Search Transactions rec.AddReturnProperty "LASTEDITDATE" rec.AddReturnProperty "DOCNAME" rec.AddReturnPropert

320 CHAPTER 5%CONTENTS_MOVE_TO_TOP%CONTENTS_MOVE_TO_TOPUse this token in conjunction with %CONTENTS_DIRECTIVE to move a folder to the top of the coll

DM API TOKENS 321%CONTENTS_MOVE_TO_TOPpDocObject.SetProperty("%CONTENTS_DIRECTIVE", _ "%CONTENTS_MOVE_TO_TOP”) 'Perform the

322 CHAPTER 5%CONTENTS_MOVE_UP%CONTENTS_MOVE_UPUse this token in conjunction with %CONTENTS_DIRECTIVE to move a folder up by one position.SyntaxPCDDo

DM API TOKENS 323%CONTENTS_MOVE_UPpDocObject.SetProperty("%CONTENTS_DIRECTIVE", "%CONTENTS_MOVE_UP”) 'Perform the update pD

324 CHAPTER 5%CONTENTS_REORDER_CONTENTS%CONTENTS_REORDER_CONTENTSUse this token in conjunction with %CONTENTS_DIRECTIVE to change the order of the fo

DM API TOKENS 325%CONTENTS_REORDER_CONTENTS 'Set the new order. pDocObject.SetProperty("%CONTENTS_REORDER_ARRAY", pOrder) 'S

326 CHAPTER 5%CONTENTS_SRC_PARENT%CONTENTS_SRC_PARENTThis token is used in conjunction with the %CONTENTS_DIRECTIVE token and the %CONTENTS_COPY_CONT

DM API TOKENS 327%CONTENTS_SRC_PARENT_LIBRARY%CONTENTS_SRC_PARENT_LIBRARYThis token is used in conjunction with the %CONTENTS_DIRECTIVE token and

328 CHAPTER 5%CONTENTS_SRC_PARENT_VERSION%CONTENTS_SRC_PARENT_VERSIONThis token is used in conjunction with the %CONTENTS_DIRECTIVE token and the %CO

DM API TOKENS 329%CONTENTS_DST_PARENT%CONTENTS_DST_PARENTThis token is used in conjunction with the %CONTENTS_DIRECTIVE token and the %CONTENTS_C

THE DM ARCHITECTURE 15DM Search Transactions row = row & _ rec.GetPropertyValue("TYPIST_ID") _

330 CHAPTER 5%CONTENTS_DST_PARENT_LIBRARY%CONTENTS_DST_PARENT_LIBRARYThis token is used in conjunction with the %CONTENTS_DIRECTIVE token and the %CO

DM API TOKENS 331%CONTENTS_DST_PARENT_VERSION%CONTENTS_DST_PARENT_VERSIONThis token is used in conjunction with the %CONTENTS_DIRECTIVE token and

332 CHAPTER 5%CONTENTS_PARENT%CONTENTS_PARENTThis token is used in conjunction with the %CONTENTS_REORDER_ARRAY token to reorganize a folder collecti

DM API TOKENS 333%CONTENTS_PARENT_VERSION%CONTENTS_PARENT_VERSIONThis token is used in conjunction with the %CONTENTS_REORDER_ARRAY token to reor

334 CHAPTER 5%CONTENTS_WHERE_USED%CONTENTS_WHERE_USEDUse this token in conjunction with %CONTENTS_DIRECTIVE to get the information about where the fo

DM API TOKENS 335%CONTENTS_WHERE_USED 'Set the chunk size. PropLists.SetChunkFactor(size) 'Execute the search. PropLists.Execute() ch

336 CHAPTER 5%COPYDOC%COPYDOCThis token is used when a document is created by copying content from another document.SyntaxPCDDocObject.SetProperty(“%

DM API TOKENS 337%COPYDOC_LIBRARY%COPYDOC_LIBRARYThe %COPYDOC_LIBRARY token is used when document content from one library is copied to create a

338 CHAPTER 5%COPYDOC_VERSION%COPYDOC_VERSIONWhen document content is being copied to create a new document, this token identifies the version of the

DM API TOKENS 339%DATA%DATAThe Execute method that PCDLookup supports returns both data and metadata. The %DATA token is used to retrieve the dat

16 CHAPTER 1DM Search Transactions 'Versions (dn) End If End SubPerforming a Simple SearchThe following example demonstrates how to do a si

340 CHAPTER 5%DATARelated ItemsSee the PCDLookup object.See the GetMetaPropertyValue method.See the following tokens:%PROPERTYNAME %PROPERTYTYPE %TIT

DM API TOKENS 341%DELETE_ALL%DELETE_ALLThis token is used with the SetProperty method that PCDDocObject supports. Used with the %DELETE_OPTION to

342 CHAPTER 5%DELETE_EXPUNGE%DELETE_EXPUNGEThis token is reserved for future use. At the current time, it is not supported for use by the DM API.Rela

DM API TOKENS 343%DELETE_OPTION%DELETE_OPTIONThis token is used with the SetProperty method that PCDDocObject supports. It allows deletion of eit

344 CHAPTER 5%DELETE_OPTIONSee the following methods:Delete SetPropertySee the following tokens:%DELETE_ALL %DELETE_EXPUNGE %DELETE_PHYSICAL_FILES

DM API TOKENS 345%DELETE_PHYSICAL_FILES%DELETE_PHYSICAL_FILESThis token is used with the SetProperty method that PCDDocObject supports. It allows

346 CHAPTER 5%DOCS_LIBRARY_NAME%DOCS_LIBRARY_NAMEWhen used with the PCDSearch object, this token retrieves the library name associated with the docum

DM API TOKENS 347%DOCS_LIBRARY_NAME'Execute the search. pRelated.Execute Related ItemsSee the following objects:PCDPropertyLists PCDSearchSe

348 CHAPTER 5%DOCUMENT_NUMBER%DOCUMENT_NUMBERThis token is used to specify the document number of the profiled item that the application requires.Syn

DM API TOKENS 349%DOCUMENT_NUMBERSee the SetProperty method.

THE DM ARCHITECTURE 17DM Search Transactions rec.AddReturnProperty "SYSTEM_ID" rec.AddReturnProperty "TYPE_ID" rec.AddRe

350 CHAPTER 5%EFFECTIVE_RIGHTS%EFFECTIVE_RIGHTSEach document can be accessed by many users, and it can be customized. Using the Access control on the

DM API TOKENS 351%EFFECTIVE_RIGHTS 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the user&apo

352 CHAPTER 5%ELAPSED_TIME%ELAPSED_TIMEThis token sets the ELAPSED_TIME column of the ACTIVITYLOG table with the amount of time that the specified do

DM API TOKENS 353%ELAPSED_TIMEpDocObject.SetProperty( "%STATUS", "%LOCK_FOR_CHECKOUT" ) 'Set the elapsed time. pDocObje

354 CHAPTER 5%ENCAPSULATION_TYPE%ENCAPSULATION_TYPEWhen users indicate that they want to view documents, those documents must be transferred from the

DM API TOKENS 355%ENCAPSULATION_TYPE'Check whether it is for the DM Viewer. If (rendition = "riff") Then pGetDoc.AddSearchCriteri

356 CHAPTER 5%FILTER_DISABLED_ROWS%FILTER_DISABLED_ROWSSome tables have a DISABLED column, which allows the system to specify that a row is disabled.

DM API TOKENS 357%FOLDERITEM_LIBRARY_NAME%FOLDERITEM_LIBRARY_NAMEWhen a new item is being linked, or added to, a folder, this token identifies th

358 CHAPTER 5%FOLDERITEM_LIBRARY_NAME'Set the parent folder’s version. pDocObject.SetProperty("PARENT_VERSION", folderVersion) '

DM API TOKENS 359%FORM_APPLICATION%FORM_APPLICATIONWhen used with the PCDPropertyList object, this token retrieves the application ID associated

18 CHAPTER 1DM Search Transactions rec.GetPropertyValue("SYSTEM_ID") _ & Chr(9) row = row & _

360 CHAPTER 5%FORM_APPLICATION'Retrieve the requested information. pDocObject.Fetch() Related Items See the following objects:PCDDocObject PCDPr

DM API TOKENS 361%FORM_DEFAULT_PRIMARY%FORM_DEFAULT_PRIMARYUse this token to identify the default profile form.SyntaxPCDPropertyList.GetPropertyV

362 CHAPTER 5%FORM_DEFAULT_PRIMARY'Get all the properties. Set pFormProperties = pDocObject.GetReturnProperties() Dim intNumRows As Integer Set

DM API TOKENS 363%FORM_LIST_TYPE%FORM_LIST_TYPEThis token is used to perform a search of a form. Returns a list properties describing the form.Sy

364 CHAPTER 5%FORM_LIST_TYPE 'Run the search. pDMObj.Fetch() Related ItemsSee the PCDDocObject object.See the SetProperty method.

DM API TOKENS 365%FORM_NAME%FORM_NAMEUse this token to set the name of a form that a search operation uses. After a search has been performed, th

366 CHAPTER 5%FORM_NAMEcheckError(pClient, "ERROR_DOCPROFILEDSP_PROFINFOEXECUTE") 'Get the returned properties. Set pProperties = pCl

DM API TOKENS 367%FORM_PROFILE_DEFAULTS%FORM_PROFILE_DEFAULTSUse this token to retrieve the default settings for a form.SyntaxPCDPropertyList.Get

368 CHAPTER 5%FORM_PROFILE_DEFAULTS 'Instantiate a PCDPropertyList object. pPropList = pDocObj.GetReturnProperties() 'Populate a property

DM API TOKENS 369%FORM_TITLE%FORM_TITLEThis token is used to get the form title from the search result set. It is usually used when searching for

THE DM ARCHITECTURE 19Document Objects reGrid.row = reGrid.RowSel reGrid.Col = 1 txtSelDocNumber = reGrid.Text docnumber = reGrid.Text

370 CHAPTER 5%FORM_TITLERelated ItemsSee the PCDPropertyList object.See the GetPropertyValue method.

DM API TOKENS 371%FT_CHARACTER_SET%FT_CHARACTER_SETThis token is used to specify a character set for documents rendered in HTML format. SyntaxPCD

372 CHAPTER 5%FT_CHARACTER_SETRelated ItemsSee the PCDGetDoc object.See the AddSearchCriteria method.

DM API TOKENS 373%FT_CONFIDENCE%FT_CONFIDENCEThis token is used when a full text search is performed. It expresses the relevance of a document re

374 CHAPTER 5%FT_CONFIDENCE%FT_MARKER_LIST %FT_SCORE %FT_TIMESTAMP %FT_VCC_LIST %FT_VCC_RULES %SCORE_GRAPHIC %SCORE_PERCENT

DM API TOKENS 375%FT_FORMAT%FT_FORMATThis token is used when a full text search is performed. This token specifies the document format. It is req

376 CHAPTER 5%FT_FORMAT%FT_SCORE %FT_TIMESTAMP %FT_VCC_LIST %FT_VCC_RULES %SCORE_GRAPHIC %SCORE_PERCENT

DM API TOKENS 377%FT_MARKER_LIST%FT_MARKER_LISTThis token is used when a full text search is performed. It allows the SearchServer™ to mark searc

378 CHAPTER 5%FT_MARKER_LIST%FT_VCC_LIST %FT_VCC_RULES %SCORE_GRAPHIC %SCORE_PERCENT

DM API TOKENS 379%FT_SCORE%FT_SCOREThis token is used when a full text search is performed. It expresses the relevance of the search criteria to

ivChild Objects of PCDDocObject Objects 7The Logon Process 7Getting a List of Available Libraries 8Providing Library Access 9DM Search Transac

20 CHAPTER 1Document Objects Dim doc As New PCDDocObject If docnumber = "" Or versionid = "" Then MsgBox "Check I

380 CHAPTER 5%FT_SCORE%FT_MARKER_LIST %FT_TIMESTAMP %FT_VCC_LIST %FT_VCC_RULES %SCORE_GRAPHIC %SCORE_PERCENT

DM API TOKENS 381%FT_SMART_DOCUMENT%FT_SMART_DOCUMENTThis token is used to convert the output stream into a MIME-encapsulated, aggregate HTML (MH

382 CHAPTER 5%FT_SMART_DOCUMENTRelated ItemsSee the PCDGetDoc object.See the AddSearchCriteria method.

DM API TOKENS 383%FT_TIMESTAMP%FT_TIMESTAMPThis token is used when a full text search is performed. It returns the last time the object was modif

384 CHAPTER 5%FT_TIMESTAMP%FT_CONFIDENCE %FT_FORMAT %FT_MARKER_LIST %FT_SCORE %FT_VCC_LIST %FT_VCC_RULES %SCORE_GRAPHIC %SCORE_PERCENT

DM API TOKENS 385%FT_VCC_LIST%FT_VCC_LISTThis token is used when a full-text search is performed. It highlights the search term in any documents

386 CHAPTER 5%FT_VCC_LIST%FT_TIMESTAMP %FT_VCC_RULES %SCORE_GRAPHIC %SCORE_PERCENT

DM API TOKENS 387%FT_VCC_RULES%FT_VCC_RULESThis token is used when a full-text search is performed. It is used by the DM Viewer to determine how

388 CHAPTER 5%FT_VCC_RULES%FT_TIMESTAMP %FT_VCC_LIST %SCORE_GRAPHIC %SCORE_PERCENT

DM API TOKENS 389%GET_ALL_RELATED%GET_ALL_RELATEDUse this token to get all items that relate to the search item, whether they are located in the

THE DM ARCHITECTURE 21Document Objects txtStatus = doc.GetReturnProperty("STATUS") Set doc = Nothing If txtStatus = 0 Then

390 CHAPTER 5%GET_ALL_RELATED'Set the related token. pRelated.AddSearchCriteria("%GET_RELATED_ITEMS", _ "%GET_ALL_RELATED")

DM API TOKENS 391%GET_LOCAL_RELATED%GET_LOCAL_RELATEDUse this token to get all the documents related to the search item that are in the same libr

392 CHAPTER 5%GET_LOCAL_RELATEDpRelated.AddSearchCriteria("%GET_RELATED_ITEMS", _ "%GET_LOCAL_RELATED") Related ItemsSee the PCD

DM API TOKENS 393%GET_RELATED_ITEMS%GET_RELATED_ITEMSThis token indicates that the search should return related items. SyntaxPCDSearch.AddSearchC

394 CHAPTER 5%GET_RELATED_ITEMSSee the AddSearchCriteria method.See the following tokens:%GET_ALL_RELATED %GET_LOCAL_RELATED %GET_REMOTE_RELATED

DM API TOKENS 395%GET_REMOTE_RELATED%GET_REMOTE_RELATEDThis token indicates that the search should only return related items that are located in

396 CHAPTER 5%GET_REMOTE_RELATED'Set the related token. pRelated.AddSearchCriteria("%GET_RELATED_ITEMS", _ "%GET_REMOTE_RELATED&

DM API TOKENS 397%HAS_SUBFOLDERS%HAS_SUBFOLDERSThis token is used if a folder has subfolders.SyntaxPCDPropertyLists.GetPropertyValue( _ “%HAS_SU

398 CHAPTER 5%HAS_SUBFOLDERSWend Related ItemsSee the PCDPropertyLists object.See the GetPropertyValue method.

DM API TOKENS 399%HITLIST%HITLISTThis token is used with the %FORM_LIST_TYPE token to retrieve data items referenced on a HITLIST form.SyntaxPCDD

22 CHAPTER 1Document Objects If (rec.ErrNumber <> 0) Then MsgBox "Fetch Doc Failure on Execute: " & _ rec.ErrNumb

400 CHAPTER 5%HITLISTRelated ItemsSee the PCDDocObject object.See the SetProperty method.See the following tokens:%FORM_LIST_TYPE %PROFILE %SEARCH

DM API TOKENS 401%ISTREAM_STATSTG_CBSIZE_LOWPART%ISTREAM_STATSTG_CBSIZE_LOWPARTThis token returns the size of a stream.SyntaxPCDGetStream.GetProp

402 CHAPTER 5%LOCK%LOCKThis token is used in conjunction with the %STATUS token to lock a document. See %STATUS for further information.SyntaxPCDDocO

DM API TOKENS 403%LOCK_FOR_CHECKOUT%LOCK_FOR_CHECKOUTThis token is used in conjunction with the %STATUS token to lock and check out a document. S

404 CHAPTER 5%LOOKUP_ID%LOOKUP_IDThis token is used to set the ID of the hit-list form that controls the data that will be returned by the look-up op

DM API TOKENS 405%LOOKUP_IDSee the SetProperty method.

406 CHAPTER 5%MAKE_READ_ONLY%MAKE_READ_ONLYThis token is used in conjunction with the %STATUS token to set a document so it cannot be altered. See %S

DM API TOKENS 407%MAKE_READ_ONLY5 Set the %OBJECT_IDENTIFIER token equal to the document number of the item that is to be made read only.6 If wor

408 CHAPTER 5%MAXDAYS%MAXDAYSIf there are many entries in the ACTIVITY table, a search for recently edited documents (RED) can return many records. T

DM API TOKENS 409%NUM_COMPONENTS%NUM_COMPONENTSWhere the document is comprised of multiple files (for example, as is the case with some CAD/CAM e

THE DM ARCHITECTURE 23Document Objects End If FetchFlag = True MsgBox "Exported document content to " _ & "designa

410 CHAPTER 5%OBJECT_IDENTIFIER%OBJECT_IDENTIFIERThe %OBJECT_IDENTIFIER token is used to set the document ID number of a document or or to retrieve

DM API TOKENS 411%OBJECT_IDENTIFIER 'Execute the search. pSearch.Execute() Related ItemsSee the following objects:PCDDocObject PCDSearchSee

412 CHAPTER 5%OBJECT_TYPE_ID%OBJECT_TYPE_IDUse this token to specify the form that is to be used in the operation.SyntaxPCDDocObject.SetProperty(“%OB

DM API TOKENS 413%ORDER_BY%ORDER_BYThis token is used to specify the field on the form that controls the sort order.SyntaxPCDPropertyLists.SetPro

414 CHAPTER 5%PCD_DELETEVERSION%PCD_DELETEVERSIONThis token is used with the %VERSION_DIRECTIVE token to delete the specified version of the current

DM API TOKENS 415%PCD_NEW_VERSION%PCD_NEW_VERSIONThis token is used with the %VERSION_DIRECTIVE token to create a new document version. See %VERS

416 CHAPTER 5%PCD_NEWSUBVERSION%PCD_NEWSUBVERSIONThis token is used with the %VERSION_DIRECTIVE token to create a new document sub-version. See %VERS

DM API TOKENS 417%PCD_PARM_HTML_RENDERING%PCD_PARM_HTML_RENDERINGA document can be rendered in HTML, RIFF or native format to the browser. To ren

418 CHAPTER 5%PCD_PARM_HTML_RENDERINGIf (strHTMLEnabled = “Y”) Then MsgBox(“A license has been installed on this DM Server.”) Else MsgBox(“No license

DM API TOKENS 419%PCD_PARM_LIB_SETTINGS%PCD_PARM_LIB_SETTINGSThis token retrieves DM Webtop library configuration parameters that are stored in t

24 CHAPTER 1Document Objects Set pclient = _ CreateObject("PCDClient.PCDSearch") pclient.SetDST DST pclient.AddSea

420 CHAPTER 5%PCD_UPDATE_VERSION%PCD_UPDATE_VERSIONThis token is used with the %VERSION_DIRECTIVE token to update create a document version to reflec

DM API TOKENS 421%PR_ACCESS_CONTROL%PR_ACCESS_CONTROLThis token identifies whether or not a user has authority to control the access of other use

422 CHAPTER 5%PR_ACCESS_CONTROLpDocObject.SetProperty("%VERSION_ID", version) 'Get the requested information. pDocObject.Fetch() &ap

DM API TOKENS 423%PR_CONTENT_COPY%PR_CONTENT_COPYThis token identifies whether or not a user has authority to copy the contents of the current do

424 CHAPTER 5%PR_CONTENT_COPY 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the doc's effect

DM API TOKENS 425%PR_CONTENT_DELETE%PR_CONTENT_DELETEThis token identifies whether or not a user has authority to delete the contents of the curr

426 CHAPTER 5%PR_CONTENT_DELETE 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the document's

DM API TOKENS 427%PR_CONTENT_EDIT%PR_CONTENT_EDITThis token identifies whether or not a user has authority to edit the contents of the current do

428 CHAPTER 5%PR_CONTENT_EDIT 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the doc's effect

DM API TOKENS 429%PR_CONTENT_RETRIEVE%PR_CONTENT_RETRIEVEThis token identifies whether or not a user has authority to retrieve the content of the

THE DM ARCHITECTURE 25Document Objects txtDefaultRights = Str(DefaultRights) pclient.ReleaseResults Set PDoc = _ Create

430 CHAPTER 5%PR_CONTENT_RETRIEVE 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the user's e

DM API TOKENS 431%PR_CONTENT_VIEW%PR_CONTENT_VIEWThis token identifies whether or not a user has authority to view the content of the current doc

432 CHAPTER 5%PR_CONTENT_VIEW 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the doc's effect

DM API TOKENS 433%PR_EDIT%PR_EDITThis token identifies whether or not a user has authority to edit the current document.SyntaxPCDDocObject.HasRig

434 CHAPTER 5%PR_EDIT 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the doc's effective righ

DM API TOKENS 435%PR_VIEW%PR_VIEWThis token identifies whether or not a user has authority to view the profile of the current document. SyntaxPCD

436 CHAPTER 5%PR_VIEW 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the user's effective rig

DM API TOKENS 437%PRIMARY_KEY%PRIMARY_KEYThis token allows the application to get the SYSTEM_ID column.SyntaxPCDSearch.AddSearchCriteria(“%PRIMAR

438 CHAPTER 5%PROFILE%PROFILEThis token is used to return information about the default profile form for the user's primary group.SyntaxPCDDocOb

DM API TOKENS 439%PROFILERelated ItemsSee the PCDDocObject object.See the SetProperty method.See the %FORM_LIST_TYPE token.

26 CHAPTER 1Document Objects GetTrusteesforProfile = True Exit Function End If ErrorHandler: MsgBox "Unhandled Error: "

440 CHAPTER 5%PROPERTYNAME%PROPERTYNAMEThe Execute method that PCDLookup supports returns both data and metadata. The %PROPERTYNAME token is used to

DM API TOKENS 441%PROPERTYNAMERelated ItemsSee the PCDLookup object.See the GetMetaPropertyValue method.See the following tokens:%DATA %PROPERTYT

442 CHAPTER 5%PROPERTYTYPE%PROPERTYTYPEThe Execute method that PCDLookup supports returns both data and metadata. The %PROPERTYTYPE token is used to

DM API TOKENS 443%PROPERTYTYPESee the GetMetaPropertyValue method.See the following tokens:%DATA %PROPERTYNAME %TITLE %VISIBLE

444 CHAPTER 5%PUBLISH_VERSION%PUBLISH_VERSIONUse this token to publish a document version.ReturnsThe %PUBLISH_VERSION token returns SUCCESS if the do

DM API TOKENS 445%PUBLISH_VERSION%PCD_DELETEVERSION %PCD_NEW_VERSION %PCD_NEWSUBVERSION %PCD_UPDATE_VERSION %REMOVE_READ_ONLY %UNPUBLISH_VERSION

446 CHAPTER 5%QS_DELETE%QS_DELETEThis token identifies whether or not a user has authority to delete a Quick Search. SyntaxPCDDocObject.HasRight(“%QS

DM API TOKENS 447%QS_DELETE 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the user’s effectiv

448 CHAPTER 5%QS_EDIT%QS_EDITThis token identifies whether or not a user has authority to edit the specified Quick Search. SyntaxPCDDocObject.HasRigh

DM API TOKENS 449%QS_EDIT 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the user's effec

THE DM ARCHITECTURE 27Document Objects lngENum = PDoc.ErrNumber If lngENum <> 0 Then Dim strEDesc As String, strENum As String

450 CHAPTER 5%QS_VIEW%QS_VIEWThis token identifies whether or not a user has authority to view the specified Quick Search. SyntaxPCDDocObject.HasRigh

DM API TOKENS 451%QS_VIEW 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the doc's effect

452 CHAPTER 5%RECENTACTIVITYDATE%RECENTACTIVITYDATEThis token allows to sort the items returned by a search according to the time they were most rece

DM API TOKENS 453%RECENTACTIVITYDATE'Show data for the retrieved documents. While (lngRow < lngRowCount) strDocName = pClient.GetReturnVa

454 CHAPTER 5%RECENTACTIVITYTIME%RECENTACTIVITYTIMEThis token allows to sort the items returned by a search according to the time they were most rece

DM API TOKENS 455%RELATED_REMOTE_LIBS%RELATED_REMOTE_LIBSThis token can be used to specify that a search for related documents should retrieve fr

456 CHAPTER 5%REMOVE_READ_ONLY%REMOVE_READ_ONLYThis token is used in conjunction with the %STATUS and %VERSION_DIRECTIVE tokens to remove the read-on

DM API TOKENS 457%REMOVE_READ_ONLY2 Set the object type (form name) to whatever value is appropriate.3 Set the DM security token (DST).4 Set the

458 CHAPTER 5%REMOVE_READ_ONLYRemoveReadOnly Document TokenUse the RemoveReadOnly Document token to remove the read-only setting from a document. PH

DM API TOKENS 459%RENDITION_TYPE%RENDITION_TYPEThis token is used to check whether the DM Server can deliver documents in BINDER mode.SyntaxPCDGe

28 CHAPTER 1Document Objects PDoc.Update 'Check for error. Dim lngENum As Long lngENum = PDoc.ErrNumber If lngENum <> 0 Then

460 CHAPTER 5%RENDITION_TYPEpGetDoc.ReleaseResults Related ItemsSee the PCDGetDoc object.See the AddSearchCriteria method.

DM API TOKENS 461%RIGHT8%RIGHT8This token identifies whether or not a user has authority to assign a document or record to a file. SyntaxPCDDocOb

462 CHAPTER 5%RIGHT8 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the user's effective righ

DM API TOKENS 463%RIGHT9%RIGHT9This token identifies whether or not a user has authority to assign a document or record to a file. SyntaxPCDDocOb

464 CHAPTER 5%RIGHT9 'Check for errors. checkError(pDocObject, "ERROR_DOCPROFILEDSP_RIGHTS") 'Get the user's effective righ

DM API TOKENS 465%SCORE_GRAPHIC%SCORE_GRAPHICThis token is used when a full text search is performed. It expresses the calculated relevance of ea

466 CHAPTER 5%SCORE_GRAPHIC%FT_SCORE %FT_TIMESTAMP %FT_VCC_LIST %FT_VCC_RULES %SCORE_PERCENT

DM API TOKENS 467%SCORE_PERCENT%SCORE_PERCENTThis token is used when a full text search is performed. It expresses the relevance of the search cr

468 CHAPTER 5%SCORE_PERCENT%FT_SCORE %FT_TIMESTAMP %FT_VCC_LIST %FT_VCC_RULES %SCORE_GRAPHIC

DM API TOKENS 469%SEARCH%SEARCHThis token is used in conjunction with %FORM_LIST_TYPE to return all search forms available to the user.SyntaxPCDD

Chapter 2AN OVERVIEW OF THE DM API 29An Overview of the DM APIIn This ChapterThis chapter describes the overall structure of the DM API, includin

470 CHAPTER 5%SEARCHSee the %FORM_LIST_TYPE token.

DM API TOKENS 471%SECURITY%SECURITYThis token is used to retrieve the user’s access rights for the specified document(s). Each user may be grante

472 CHAPTER 5%STATUS%STATUSThis token is used to change the status of a document. The document status can be set to one of the following:• Lock the d

DM API TOKENS 473%STATUSpDocObject.SetProperty( “%OBJECT_IDENTIFIER”, strDocNum ) 'Set the status. pDocObject.SetProperty( "%STATUS&qu

474 CHAPTER 5%TARGET_LIBRARY%TARGET_LIBRARYThis token specifies the library to use for various actions (such as searching or creating documents).Synt

DM API TOKENS 475%TITLE%TITLEThe Execute method that PCDLookup supports returns both data and metadata about the object specified in the lookup o

476 CHAPTER 5%TITLERelated ItemsSee the PCDLookup object.See the GetMetaPropertyValue method.See the following tokens:%DATA %PROPERTYNAME %PROPERTYTY

DM API TOKENS 477%TRUSTEE_ID%TRUSTEE_IDThe %TRUSTEE_ID token, together with the %TRUSTEE_RIGHTS and %TRUSTEE_TYPE tokens, allows trustee settings

478 CHAPTER 5%TRUSTEE_ID%TRUSTEE_TYPE

DM API TOKENS 479%TRUSTEE_RIGHTS%TRUSTEE_RIGHTSThe %TRUSTEE_RIGHTS token, together with the %TRUSTEE_ID and %TRUSTEE_TYPE tokens, allows trustee

vPCDNetworkInfo 69PCDPropertyList 83PCDPropertyLists 96 PCDPutDoc 97PCDPutStream 102PCDRecentDoc 103PCDSearch 105PCDSQL 107PCDTru

30 CHAPTER 2The PCDClient ObjectThe PCDClient ObjectYour custom applications interact with the DM Server through a number of objects that are collect

480 CHAPTER 5%TRUSTEE_RIGHTSSee the AddProperty method.See the following tokens:%TRUSTEE_ID %TRUSTEE_TYPE

DM API TOKENS 481%TRUSTEE_TYPE%TRUSTEE_TYPEThe %TRUSTEE_TYPE token, together with the %TRUSTEE_ID and %TRUSTEE_RIGHTS tokens, allows trustee sett

482 CHAPTER 5%TRUSTEE_TYPERelated ItemsSee the PCDPropertyList object.See the AddProperty method.See the following tokens:%TRUSTEE_ID %TRUSTEE_RIGHTS

DM API TOKENS 483%TRUSTEES_ADD%TRUSTEES_ADDUse this token to add new entities (people, groups, etc.) to the current trustee list.SyntaxPCDDocObje

484 CHAPTER 5%TRUSTEES_ADD%TRUSTEES_REMOVE %TRUSTEES_SET %TRUSTEES_UPDATE

DM API TOKENS 485%TRUSTEES_REMOVE%TRUSTEES_REMOVEUse this token to delete one or more trustees from the current list of trustees for the specifie

486 CHAPTER 5%TRUSTEES_REMOVE%TRUSTEES_ADD %TRUSTEES_SET %TRUSTEES_UPDATE

DM API TOKENS 487%TRUSTEES_SET%TRUSTEES_SETUse this token to set trustee information.SyntaxPCDDocObject.SetProperty(“%TRUSTEES_UPDATE”, _ “%TRUS

488 CHAPTER 5%TRUSTEES_SET%TRUSTEES_UPDATE

DM API TOKENS 489%TRUSTEES_UPDATE%TRUSTEES_UPDATEUse this token to set trustee information.SyntaxPCDDocObject.SetProperty(“%TRUSTEES_UPDATE”, _

AN OVERVIEW OF THE DM API 31Early and Late BindingPCDSQL PCDTrusteeList Early and Late BindingYou can create objects in the DM API using either e

490 CHAPTER 5%TRUSTEES_UPDATE'Perform the update. pDocObject.Update Related ItemsSee the PCDDocObject object.See the SetProperty method.See the

DM API TOKENS 491%UNLOCK%UNLOCKThis token is used in conjunction with the %STATUS token to unlock a document. See the “%STATUS” token on page 472

492 CHAPTER 5%UNPUBLISH_VERSION%UNPUBLISH_VERSIONThis token is used with the %VERSION_DIRECTIVE token to reset a previously published document versio

DM API TOKENS 493%UNPUBLISH_VERSION5 Set the %OBJECT_IDENTIFIER token equal to the document number of the document version that is have its publi

494 CHAPTER 5%USER_ID%USER_IDThis token is used to set the user ID property for various actions.SyntaxPCDDocObject.SetProperty(“%USER_ID”, _ “vntUser

DM API TOKENS 495%VERIFY_ONLY%VERIFY_ONLYThis token allows you to verify that the attributes are correct for the document. This is used primarily

496 CHAPTER 5%VERIFY_ONLYRelated ItemsSee the PCDDocObject object.See the SetProperty method.

DM API TOKENS 497%VERSION_AUTHOR%VERSION_AUTHORThis token allows to specify the author of the document version.SyntaxPCDDocObject.SetProperty(“%V

498 CHAPTER 5%VERSION_COMMENT%VERSION_COMMENTThis token allows you to specify the comment for the document version.SyntaxPCDDocObject.SetProperty(“%V

DM API TOKENS 499%VERSION_COMMENTSee the SetProperty method.

Methods and Properties Supported by DM API ObjectsEach of the DM API objects supports two or more methods or properties that perform the various tasks

500 CHAPTER 5%VERSION_DIRECTIVE%VERSION_DIRECTIVEThis token indicates that any of several supported actions is to affect the specified document versi

DM API TOKENS 501%VERSION_DIRECTIVEpDelObject.SetDST( strDST ) 'Set the version ID pDelObject.SetProperty( "%VERSION_ID", version

502 CHAPTER 5%VERSION_ID%VERSION_IDThis token allows a specific version ID to be set for the document.SyntaxPCDDocObject.GetReturnProperty(“%VERSION_

DM API TOKENS 503%VERSION_ID 'Execute the search. pVer.Execute Related ItemsSee the following objects:PCDDocObject PCDGetDoc PCDPutDocSee th

504 CHAPTER 5%VERSION_LABEL%VERSION_LABELThis token is used to retrieve the preview content.SyntaxPCDGetDoc.AddSearchCriteria(“%VERSION_LABEL”, _ “P

DM API TOKENS 505%VERSION_TO_INDEX%VERSION_TO_INDEXThis token indentifies a version identified in a search whose content is now to be retrieved.

506 CHAPTER 5%VERSION_TYPIST%VERSION_TYPISTThis token is used to identify the typist for the specified document version.SyntaxPCDDocObject.SetPropert

DM API TOKENS 507%VISIBLE%VISIBLEThe Execute method that PCDLookup supports returns both data and metadata. The %VISIBLE token returns a Boolean

508 CHAPTER 5%VISIBLERelated ItemsSee the PCDLookup object.See the GetMetaPropertyValue method.See the following tokens:%DATA %PROPERTYNAME %PROPERTY

AN OVERVIEW OF THE DM API 33Methods and Properties Supported by DM API ObjectsHasRight RevokeRight SetDST SetObjectType SetProperties SetProperty

34 CHAPTER 2Methods and Properties Supported by DM API ObjectsSetSearchCriteria SetSearchObject PCDGetFormAddSearchLib Execute GetPropertyValue SetDS

AN OVERVIEW OF THE DM API 35Methods and Properties Supported by DM API ObjectsPCDLookupAddOrderByProperty AddSearchCriteria AddSearchLib AddUserF

36 CHAPTER 2Methods and Properties Supported by DM API ObjectsUnitType UserName PCDNetworkInfoGetDomainList GetGroupList GetGroupMembers GetRowCount

AN OVERVIEW OF THE DM API 37Methods and Properties Supported by DM API ObjectsGetCurrentPropertyValue NewEnum NextProperty NextRow SetChunkFactor

38 CHAPTER 2Methods and Properties Supported by DM API ObjectsPCDRecentDocAddOrderByProperty AddReturnMetaProperty AddReturnProperty AddSearchCriteri

AN OVERVIEW OF THE DM API 39Methods and Properties Supported by DM API ObjectsPCDSearchAddOrderByProperty AddReturnMetaProperty AddReturnProperty

viDeleteTrustee 163EndGetBlock 164ErrDescription 165ErrNumber 166Execute 167Fetch 169FetchTrustees 170GetAliasList 174GetAt 175GetCo

40 CHAPTER 2Methods and Properties Supported by DM API ObjectsGetColumnName GetColumnValue GetDBVendor GetNextKey GetRowCount GetRowsAffected GetSQLE

AN OVERVIEW OF THE DM API 41Tokens Supported by DM API Methods and PropertiesTokens Supported by DM API Methods and PropertiesTokens are special

42 CHAPTER 2Tokens Supported by DM API Methods and Properties

Chapter 3DM API OBJECTS 43DM API ObjectsIn This ChapterThis chapter describes each of the DM objects, including their syntax, usage, and other re

44 CHAPTER 3PCDASPFileUploadPCDASPFileUploadUse this object only from scripts running inside Active Server Pages (ASP). This object is used to read f

DM API OBJECTS 45PCDASPFileUploadPCDASPFileUpload is a helper class/interface/object that supports the tying of the POST of an ASP Multipart/Form

46 CHAPTER 3PCDASPFileUpload. . .Related ItemsSee the following methods:Execute IsEmpty OnEndPage OnStartPage See the following properties:ErrDes

DM API OBJECTS 47PCDDocObjectPCDDocObjectThis object is one of the true workhorses of the DM API. Custom applications use it to manipulate Docume

48 CHAPTER 3PCDDocObjectSetDST SetObjectType SetProperties SetProperty SetTrustee SetTrustees Update UpdateTrustees See the following properti

DM API OBJECTS 49PCDEnumPropertyListsPCDEnumPropertyListsThis object allows you to iterate through collections of property lists. Most often used

viiGetPropertyIndex 206GetPropertyValue 209GetPropertyValueByIndex 211GetReturnProperties 213GetReturnProperty 215GetRowCount 216GetR

50 CHAPTER 3PCDErrorPCDErrorThis object is a base object for all other PCDClient objects. It provides common properties that you access through the o

DM API OBJECTS 51PCDGetDocPCDGetDocThis object is used to manage the retrieval of a set of physical files that comprise the components of one ver

52 CHAPTER 3PCDGetDoc7 After file retrieval is complete, release memory associated with your PCDGetDoc object.

DM API OBJECTS 53PCDGetDocExampleThe following example shows you can use PCDGetDoc to retrieve the name of a file that contains a document in you

54 CHAPTER 3PCDGetDoc. .Related ItemsSee the following methods: See the following properties:ErrDescription ErrNumber AddSearchCriteria Execute G

DM API OBJECTS 55PCDGetFormPCDGetFormUse this object to retrieve information contained in the FORMS table in the SQL database. It is presently us

56 CHAPTER 3PCDGetLoginLibsPCDGetLoginLibs Use this object to get a list of available logon libraries from the DM Server. This is a list of the libra

DM API OBJECTS 57PCDGetLoginLibsReDim strLibName(LNumOfLibs) For LCounter = 0 To LNumOfLibs strLibName(LCounter) = _ objGetLibs.GetAt(LCou

58 CHAPTER 3PCDGetStreamPCDGetStreamUse this object to provide the user with a way to read the contents of a physical file. SyntaxPCDGetStream.method

DM API OBJECTS 59PCDGetStreamlngCurCount = 0 lngTotCount = 0 'Set our library objDOC.SetProperty "%TARGET_LIBRARY", bstrLib &apo

viiiRead 254ReleaseResults 255Reset 256RevokeRight 257Seek 259SetChunkFactor 260SetComplete 262SetDST 263SetLibrary 265SetLookupId

60 CHAPTER 3PCDGetStream lngTotCount = lngTotCount + lngCurCount bytInArray = objGetStream.Read(5120) lngCurCount = objGetStream.BytesRead Wend

DM API OBJECTS 61PCDLoginPCDLoginUse this object to create or append validated network aliases to a document security token (DST)SyntaxPCDLogin.m

62 CHAPTER 3PCDLookupPCDLookupPCDLookup allows you to execute a lookup of data stored in validated SQL columns, such as AUTHOR or DOCUMENTTYPE. You c

DM API OBJECTS 63PCDLookupExampleThe following example demonstrates how you can use PCDLookup to create and process a Lookup search. It includes

64 CHAPTER 3PCDLookup vbCr & "you selected in the Typist field?" strAns = MsgBox(strPrompt, vbYesNo, strTitle) intAns = CInt(s

DM API OBJECTS 65PCDLookup 'Unsorted. This assures unsorted results, but 'it may not be required unless there were 'p

66 CHAPTER 3PCDLookup lstResultSet.Clear 'Set pointer position to row 0 in the result set. 'NextRow will then increment it to the firs

DM API OBJECTS 67PCDLookup Loop Loop 'Cleanup... objPCDLookup.ReleaseResults Set objPCDLookup = Nothing Set objPCDPropList

68 CHAPTER 3PCDNetAliasListPCDNetAliasListThe PCDNetAliasList object stores a list of network aliases. A network alias consists of the following:•a U

DM API OBJECTS 69PCDNetworkInfoPCDNetworkInfoThe PCDNetworkInfo object supports the integration of DM with your network-based security. The metho

ixChapter 5 DM API Tokens%ADD_ATTACHMENT 302%ATTACHMENT_ID 303%CHECKIN_DATE 304%CHECKOUT_COMMENT 305%CONTENT 306%CONTENTS_AFTER_ITEM

70 CHAPTER 3PCDNetworkInfoPublic sDST As String Private Sub cbDomain_Click() DomainForm.oNWInfo.SetDST (sDST) DomainForm.Show End Sub Private S

DM API OBJECTS 71PCDNetworkInfo Public oNWInfo As New PCDNetworkInfo Private Sub cbCancel_Click() Unload DomainForm End Sub Private Sub

72 CHAPTER 3PCDNetworkInfo nNumRows = oNWInfo.GetRowCount() End If If nNumRows = 0 Then MsgBox "You do not have access to Domain “

DM API OBJECTS 73PCDNetworkInfo 'Pre-select the first item in the list. lstDomainUserList.ListIndex = 0 End If

74 CHAPTER 3PCDNetworkInfo 'Pre-select the first item in the list. lstDomainUserList.ListIndex = 0 End If End Sub Public

DM API OBJECTS 75PCDNetworkInfo IsMemberForm.sDomainName = "MyDomain" IsMemberForm.sGroupName = "MyGroup" IsMemberFor

76 CHAPTER 3PCDNetworkInfo If nResult = 0 Then nNumRows = oGroupInfo.GetRowCount() End If If nNumRows = 0 Then MsgBox "You do no

DM API OBJECTS 77PCDNetworkInfo End If End If cbGetMembers.Enabled = False End Sub Private Sub lstDomains_Click() sDomainName

78 CHAPTER 3PCDNetworkInfo End Sub Private Sub lstGroups_Click() sGroupName = lstGroups.Text cbGetMembers.Enabled = True End Sub Public oMem

DM API OBJECTS 79PCDNetworkInfo Dim sMember As String Dim nNumRows As Long 'Retrieve the GroupMembers from the network nResult = o