IRecipeExchange::checkout

Method Signatures

 

C\C++

HRESULT

CheckOut (

RecipeExchangeType rType,

BSTR recipeName

BOOL bRecursive

)

VB

Public Sub

CheckOut (

ByVal rType As RecipeExchangeType,

ByVal recipeName As String,

ByVal bRecursive As Boolean

)

This method checks the specified recipe out of the Version Cpntrol database.

Return Values

S_OK - success

E_NOT_CONNECTED - Please call Connect First.

E_CHECKOUT_FAILED - The recipe check out Failed.

E_VC_NOT_ENABLED - The version control feature not enabled.

E_INVALID_TYPE - The type is not supported.

else - failed

Memory Allocation

None

Visual Basic Usage Example

Private Sub Button1_Click()

  Dim myRecipeExchange As RecipeExchange
  Set myRecipeExchange = New RecipeExchange
  myRecipeExchange.Connect
  
  Dim itemType As tagRecipeExchangeType
  itemType = Procedure
  Dim itemName As String
  itemName = "OP_CS_ADDITION"
  Dim bRecursive As Boolean
  bRecursive = True
    
  Call myRecipeExchange.CheckOut(itemType, itemName, bRecursive)
  
  myRecipeExchange.Disconnect

End Sub

Parameter Name

Purpose

rType

The type of the specified recipe to be checked out.

recipeName

The name of the specified recipe to be checked out.

This name should include the path.

e.g., "operationFolder1/op1", "procedure1/formula1".