Manuals / Brands / Photography / Digital Camera / ADIC / Photography / Digital Camera

ADIC 601355 Rev A - page 1109

1 1192

Download 1192 pages, 5.67 Mb

API Guide

601355 Rev A API Functions 2-1059

Functins

See Also • vsapi(l),

• VS_Error_GetFields(l),

• VS_Global_SetFields(l),

• VSCMD_Reprioritize(l)

Contents

Main Trademark Notice Copyright Notice U.S. Government Rights Restricted Technical Assistance Documentation READER COMMENT FORM Page Contents Preface Getting Started 1 API Functions 2 Page Page Page Page Page Page Preface Page Page Conventions are listed below: Convention Example - 20 Books Online Books Page Getting Started Page API Directory Structure Page Application Program Interface Extensible Consistent Port able Flexible Page Client Interface Summary Page Unsolicited Communica- tion Vol Ser v AP I Integration Page API Types Objects Handles Each handle has the four base routines descried in the table below: Page Naming Conventions The table below describes the API naming conventions: Page Page Page Dispatch Routines Global Parameters Global Vari ables The following global variables are available to any software using the VolServ API. API Error Handling Page Using the API Command Handle Command Calls Command Defaults Command Status Page Processing Asynchronous Synchronous API Functions follows: Page Page API Functions Page Page Page Page Page Page Create Synopsis Page Page Destroy Synopsis Page handle, that handle is no longer valid and should not be used. Page GetFields Synopsis Page Page Page Page Page Page Page Page Page SetFields Page Page Page Page Page Page Page Page Page Page Synopsis Page Page an archive media class handle, that handle is no longer valid and should not be used. Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Synopsis Page Page Page GetError- Fields Page Page Synopsis Page Page Page GetStatus- Fields Page Page Page Page Page Page Page Page Page Synopsis Page Page VS_Command_Create(l), VS_Command_Destroy(l), VS_Command_GetFields(l), Page Page Page Page Page Page Page Page Page Page Synopsis Page VS_Component_Create(l), VS_Component_Destroy(l), VS_Component_SetFields(l), Page Page Page Page Page Page Page Page Create Synopsis Page Page Destroy Synopsis Page handle, that handle is no longer valid and should not be used. Page GetFields Synopsis Page Page Page SetFields Synopsis Page Page Page Page Create Synopsis Page Page Page Page Page Destroy Synopsis Page Page Page Page Page Page GetFields Synopsis Page Page Page Page Page SetFields Synopsis Page Page Page Page Page Page _Create Synopsis Page Page Page Page Page _Destroy Synopsis Page Page Page Page Page _GetFields Synopsis Page Page Page Page _SetFields Synopsis Page Page Page Page Page Page VS_Drive_ Synopsis Page Page Page VS_Drive_ Synopsis Page Page Page VS_Drive_Get Fields Synopsis Page Page Page Page Page VS_Drive_Set Fields Synopsis Page Page Page when a parent component goes off-line. The VSE_COMP_UNAVAIL state cannot be specified by the user. Page _Create Synopsis Page Page _Destroy Synopsis Page Page _GetFields Synopsis Page Page Page Page _SetFields Synopsis Page Page Page VS_Error_Get Fields Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Synopsis Page Page Page Page Page Page VS_Global_ GetFields Synopsis Page Page Page Page VS_Global_ SetFields Synopsis Arguments Page Page Page Page Page VS_Initialize Synopsis Page Page Page Create Synopsis Page Page Page Destroy Synopsis Page Page Page GetFields Synopsis Page Page Page Page Page SetFields Synopsis Page Page Page Page VS_Media_Create(l), VS_Media_Destroy(l), VS_Media_SetFields(l) Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Synopsis Page Page Page Create Synopsis Page Page commands. Page Destroy Page Page Page Synopsis Page Page Page Page Page Page Page SetFields Synopsis Page Page VSE_ERR_OUTOFRANGE - Specified entry does not exist in the tables range of values. Page Page Page Page Create Synopsis Page Page Page Page Destroy Synopsis Page Page Page Page GetFields Synopsis Page Page Page Page Page Page Page Listen Synopsis VSE_ERR_TIMEOUT - The VolServ API timed out waiting for MediaClass callbacks from VolServ. Page Page Page Page SetFields Synopsis Page Page Page Page Page Page Create Synopsis Page Page Destroy Synopsis Page Page GetFields Synopsis Page Page Page SetFields Synopsis Page Page Page VS_Select Synopsis Page Page VS_Status_ GetFields Synopsis Page Page Page Page Page Page Page Page Page Page Page Page Page AddEntry Synopsis Page Page Page Page Page Page Create Synopsis Page Page Page Page Page Page CreateAdd- Entry Synopsis Page Page Page Destroy Synopsis Page Page Page VS_Table_Get Fields Synopsis Page Page Page RemoveEntry Synopsis Page Page Page VS_Table_Set Fields Synopsis Page Page Page Page VS_Terminate Synopsis Page _Create Synopsis Page Page Page _Destroy Synopsis Page Page capacity handle, that handle is no longer valid and should not be used. Page _GetFields Synopsis Page Page Page Page Page Page _SetFields Synopsis Page Page Page Page Page Page ArchiveQuery Synopsis Page Page Page Page Page Page Page Page Page ArchiveQuery _SetDefaults Synopsis Page Page Page Page Page ArchiveVary Synopsis Page Page Page Page Page Page Page ArchiveVary_ Synopsis Page Page Page Page Page VSCMD_Audit Synopsis Page Page Page Page Page Page Page Page VSCMD_Audit _SetDefaults Synopsis Page Page Page Page VS_Global_SetFields(l), VSCMD_Audit(l) Cancel Synopsis Page Page Page Page Page Page Page Page Cancel_ Synopsis Page Page Page Page Page Checkin Synopsis Page Page Page Page Page Page Page Page Checkin_ Synopsis Page Page Page VS_Error_GetFields(l), VS_Global_SetFields(l), VSCMD_Checkin(l) Checkout Synopsis Page Page Page Page Page Page Page Page Checkout_Set Synopsis Page Page Page VS_Error_GetFields(l), VS_Global_SetFields(l), VSCMD_Checkout(l) VSCMD_Clear Eject Synopsis Page Page Page Page VolServ does not generate intermediate status messages in response to a ClearEject request. Page Page Page VSCMD_Clear Eject_ Synopsis Page Page Page Page Page Connect Synopsis Page Page Page Page Page Page Page Page Page Page Connect_Set Synopsis Page Page Page Page Page Connect- Synopsis Page Page Page Page Page Page Page Page Set-Defaults Synopsis Page Page Page VS_Error_GetFields(l), VS_Global_SetFields(l), VSCMD_ConnectQuery(l) CreateArchiv eMediaClass Synopsis Page Page Page Page Page Page Page Page Page Page Page Page Page CreateArchiv eMediaClass_ Synopsis Page Page Page Page Page Page Page Page Page CreateMedia- Synopsis Page Page Page Page Page Page Page Page Page Page Page Page CreateMedia- Class_ Synopsis Page Page Page Page Page Page Page Page Var y Synopsis Page Page Page Page Page Page Page Page Page Page Vary_ Synopsis Page Page Page Page Page Page Page Export Synopsis Page Page Page Page Page Page Page Page Export_ Synopsis Page VSE_FALSE - API failure - An appropriate error code is set in VSG_Error. Page Page Import Synopsis Page Page Page Page Page Page Page Page Page Import_ Synopsis Page Page Page Page Intransit- Synopsis Page Page Page Page Page Page Page Intransit- Query_Set- Synopsis Page Page Page Page VSCMD_Lock Synopsis Page Page Page Page Page Page Page Page Page VSCMD_Lock _SetDefaults Synopsis Page Page Page Page MediaClass- Synopsis Page Page Page Page Page Page Page Page MediaClass- Synopsis Page Page Page Page MediaQuery Synopsis Page Page Page Page Page Page Page MediaQuery_ Synopsis Page Page Page Page MediaType- Synopsis Page Page Page Page Page Page Page Page Page Page VSE_FALSE - API failure - An appropriate error code is set in VSG_Error. Page VS_Error_GetFields(l), VS_Global_SetFields(l), Page Page Page Page Page Page Page Page Page Page Page ModifyMedia_ Synopsis Page Page Page Page Page Page CreatePool Synopsis Page Page Page Page Page Page Page Page CreatePool_ Synopsis Page Page Page Page Page DeleteArchive MediaClass Synopsis Page Page Page Page Page Page Page Page DeleteArchive Synopsis Page Page Page Page Page DeleteMedia Synopsis Page Page Page Page Page Page Page DeleteMedia Synopsis Page Page VSE_ERR_NULLSTRING - A null value was passed to a VS_Error_GetFields(l), VS_Global_SetFields(l), VSCMD_DeleteMediaClass(l) DeletePool Synopsis Page Page Page Page Page Page Page DeletePool_ Synopsis Page Page Page Page Disconnect Synopsis Page Page Page Page Page Page Page Page Page Disconnect_ Synopsis Page Page Page Page Page Dismount Synopsis Page VSID_USAGE_TIME (VST_USAGE) Page Page Page Page Page Page Dismount_Set Synopsis Page Page Page Page Page PoolQuery Synopsis Page Page Page Page Page Page Page Page PoolQuery_ Synopsis Page Page Page Page Page Query Page Page Page Page Page Page Page Page Synopsis Page Page Page Page Page Modify ArchiveMedia Synopsis Page Page Page Page Page Page Page Page Page Page Page Page Page Page Modify ArchiveMedia Synopsis Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Synopsis Page Page Page Page Page Page Page ModifyPool Synopsis Page Page Page Page Page Page Page Page Page ModifyPool_ Synopsis Page Page Page VSID_MODPOOL_OPTION_LIST parameters require that two Page Mount Synopsis Page Page Page - Successful execution if the API is operating in synchronous mode Page Page Page Page Page Page Page Page Page Page Mount_Set Synopsis Page Page Page Page Page Page Page VSCMD_Move Synopsis Page - Successful execution if the API is operating in synchronous mode Page Page Page Page Page Page Page VSCMD_Move _SetDefaults Synopsis Page Page Page Page Page VSCMD_Multi Mount Synopsis Page Page Page Page Page Page Page Page Page Page MultiMount_ Synopsis Page Page Page Page Page VSCMD_Ping Synopsis Page Page Page QueryMount Synopsis Page Page Page Page Page Page Page Page QueryMount_ Synopsis Page Page Page VS_Error_GetFields(l), VS_Global_SetFields(l), VSCMD_QueryMount(l) Reclassify Synopsis Page Page Page Page Page Page Page Page Page Page Page Reclassify_ Synopsis Page Page Page Page Page Reprioritize Synopsis Page Page Page Page Page Page Page Page Reprioritize_ Synopsis Page Page Page Page Page Request- Synopsis Page Page Page Page Page Page Page Request Query_Set Synopsis Page Page Page VS_Error_GetFields(l), VS_Global_SetFields(l), VSCMD_RequestQuery(l) Unlock Synopsis Page Page Page Page Page Page Page Unlock_Set Synopsis Page Page Page Page Page Page Page Page Page 601355 Rev A Valid Status Fields A-3 Table A-1 VSID_ACTION_CODE through VSID_COMPONENT_HANDLE_ENTRY A-4 Valid Status Fields 601355 Rev A 601355 Rev A Valid Status Fields A-5 Table A-2 VSID_COMPONENT_HANDLE_TABLE through VSID_DRIVE_HANDLE A-6 Valid Status Fields 601355 Rev A 601355 Rev A Valid Status Fields A-7 Table A-3 VSID_DRIVE_HANDLE_ENTRY through DSID_DRIVEPOOL_NAME A-8 Valid Status Fields 601355 Rev A Table A-4 VSID_ERROR_CODE through VSID_MEDIA_HANDLE Page 601355 Rev A Valid Status Fields A-11 Table A-5 VSID_MEDIA_HANDLE through VSID_MEDIATYPE_HANDLE A-12 Valid Status Fields 601355 Rev A Table A-6 VSID_STATUS_CODE through VSID_WAIT_REASON Page Table A-7 VSID_MEDIATYPE_HANDLE_ENTRY through VSID_SEQUENCE_TABLE Page Page Page Page Page Error Codes Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Example