IRecipeExchange::download

Method Signatures

C\C++

HRESULT

Download (

BSTR nodeName,

BSTR* strlog,

BOOL bPermitDownloadOfCheckedoutItems,

BOOL bPermitDownloadOfUnauthorizedItems

)

Public Sub

Download (

ByVal nodeNameAs String,

ByRef strlog As String,

ByVal bPermitDownloadOfCheckedoutItems As Boolean,

ByVal bPermitDownloadOfUnauthorizedItems As Boolean

)

This method downloads the batch subsystem of specified node.

Return Values

S_OK - success

E_NOT_CONNECTED - Please call Connect First.

E_DOWNLOAD_FAILED - The download Failed.

else - failed

Memory Allocation

The caller is responsible for release of the strlog.

Visual Basic Usage Example

Private Sub Button1_Click()

  Dim myRecipeExchange As RecipeExchange
  Set myRecipeExchange = New RecipeExchange
  myRecipeExchange.Connect
  Dim bstrLog As String

  Dim nodeName As String
  nodeName = "Node1"
  Dim bPermitDownloadOfCheckedoutItems As Boolean
  bPermitDownloadOfCheckedoutItems = True
  Dim bPermitDownloadOfUnauthorizedItems As Boolean
  bPermitDownloadOfUnauthorizedItems = True
  Call myRecipeExchange.Download(nodeName, 
                                 bstrLog, 
                                 bPermitDownloadOfCheckedoutItems,     
                                 bPermitDownloadOfUnauthorizedItems
 )
  MsgBox bstrLog, vbOKOnly, "DownLoad"

  myRecipeExchange.Disconnect

End Sub

Parameter Name	Purpose
NodeName	The name of the specified node which batch subsystem to be downloaded.
strlog	String that will return the log information of the downloading.
bPermitDownloadOfCheckedoutItems	=True, permit to download checkout recipes. =False, not allowed to download checkout recipes. Default = False
bPermitDownloadOfUnauthorizedItems	=True, permit to download unauthorized recipes. =False, not allowed to download unauthorized recipes. Default = False