InitiateTransfer function

You are here: BlueCieloECM.GcfSupport class > InitiateTransfer function

InitiateTransfer function

Initiates a Global Collaboration Framework transfer of the specified document.

Note This function can more conveniently be called via the GCF VBScript function GCFInitiateTransfer, which initiates the transfer for the selected document.

Syntax

Function InitiateTransfer(DocID, DestinationShare, TransferOwnership, _
                          OnSchedule, Enlistment, EMailAddress, FileName)

Parameters
Name	Description
DocID	The ID of the document for which to initiate a transfer.
DestinationShare	The name of the GCF share to which the transfer is to be initiated.
TransferOwnership	If True, ownership will be transferred to the share specified in DestinationShare.
OnSchedule	If True, the transfer will occur with the next scheduled transfer (not immediately).
Enlistment	If True, the vault specified in DestinationShare will be enlisted for the document.
EMailAddress	The email address to which to send a notification when the document has been imported in the vault specified in DestinationShare.
EMailText	The text of the email message.
FileName	The name of the document for which to initiate transfer.

Return value

When successful, returns a variant array. When an error occurred, returns the error message.

Related concepts

Understanding document ownership

Understanding ownership transfers

Cross-site workflow implementation

Understanding claim ownership transfers

Transferring ownership upon release

Related information

GCF privileges

GCFInitiateTransfer function

RequestOwner function