CloneDocument(ObjectCache,string,CloneDocumentOptions) Method

Summary

Clones (creates a copy) of an existing document in the cache.

Syntax

C++

public static LEADDocument CloneDocument( 
   ObjectCache cache, 
   string documentId, 
   CloneDocumentOptions options 
)

Public Shared Function CloneDocument( 
   ByVal cache As ObjectCache, 
   ByVal documentId As String, 
   ByVal options As CloneDocumentOptions 
) As LEADDocument

public:  
   static LEADDocument^ CloneDocument( 
      ObjectCache^ cache, 
      String^ documentId, 
      CloneDocumentOptions^ options 
   )

Parameters

cache

Cache containing the existing and new document. This value must not be null.

documentId

ID of the document to clone. This value must not be null and must be the ID of an existing document in cache.

options

Options to use during cloning.

Return Value

A brand new document that is an exact copy of the document referenced by documentId.

Remarks

This method performs the following:

Loads the document from the cache using LoadFromCache passing cache and documentId.
Calls LEADDocument.Clone on the resulting object and returns the created document.

Refer to LEADDocument.Clone for more information.

Use CloneDocument(ObjectCache,ObjectCache,Uri,CloneDocumentOptions) to clone an uploaded document.

Example

For an example, refer to LEADDocument.Clone.

Requirements

Target Platforms