HyperWorks Desktop

LibraryManager_CheckOut

LibraryManager_CheckOut

Previous topic Next topic No expanding text in this topic  

LibraryManager_CheckOut

Previous topic Next topic JavaScript is required for expanding text JavaScript is required for the print function  

NAME


LibraryManager_CheckOut

 

SYNTAX  


LibraryManager_CheckOut <generic data manager handle> <content handle> <path> < hwStringList> <get reference file flag> < append folder flag>

 

TYPE/CLASS


Library Manager

 

DESCRIPTION


Gets the file associated with the content. The file will have write permission. By default all of the contents referred to by this content will also be retrieved (only retrieved not checked out) to the same path. If you want to get/check-out the referenced contents to another path, you should pass getrefs as false and then get the references from the content and explicitly get/check-out them to the desired paths recursively. If appendFolder is false, then the files will be retrieved directly under the given path, otherwise, depending on the folder of the content, the corresponding folder will be created. All the files that were copied to the local machine as a result of this operation are returned in the filelist argument. If the content is not the latest revision then check out will fail. Content needs to be updated to the latest version for check out.

generic data manager handle

Generic data manager handle. See DMDirector_OpenWorkspace.

content handle

Content handle. See ContentInterfaceList_at.

Path

Path where you want to download the file to. If the path is empty (“”) the file will be downloaded to the current workspace.

hwStringList

String list pointer

Get reference file flag- Use this flag to retrieve any referenced contents

0 – False

1 – True

Append folder flagUse flag to retrieve the content under the exact folder structure as in the library.

0 – False

1 - True

 

EXAMPLES


set gdm [DMDirector_OpenWorkspace $director $ws $repoh 0]

set qryhandle [$gdm GetQuery]

set st [$gdm ExecQuery $ qryhandle $clist]

set stringtosearch "MS6000"

set clist [ContentInterfaceList]

set status [$gdm ExecQuery $stringtosearch $clist]

set ci [ContentInterfaceList_at $clist 0]

set path ""

set appendFolder 1

set getRefs 0

set flist [hwStringList]

set getstatus [LibraryManager_CheckOut $gdm $ci $path $flist $getRefs $ appendFolder]

puts “Message à [hwLMStatus_GetMessage $getstatus]”

 

ERRORS


 

SEE ALSO


DMDirector_OpenWorkspace

GetQuery

Get

ExecQuery