objio_sm.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef OBJIO_SM_H
#define OBJIO_SM_H

#include <objio/libobjio_exports.h>

#define OBJIO_SM_class_name_c                   "StorageMedia"
#define OBJIO_SM_Disk_Device                    "Disk"
#define OBJIO_SM_Tape_Device                    "Tape"
#define OBJIO_SM_name_size_c                    32
#define OBJIO_SM_description_size_c             240

#define OBJIO_SM_online_msg                         "OBJIO_SM_online"
#define OBJIO_SM_retrieve_msg                     "OBJIO_SM_retrieve"
#define OBJIO_SM_store_msg                         "OBJIO_SM_store"

#ifdef __cplusplus
    extern "C"{
#endif

extern OBJIO_API int OBJIO_SM_create_media(
    char             media_name[OBJIO_SM_name_size_c+1],            
    char             logical_device[OBJIO_SM_description_size_c+1], 
    char             media_type[OBJIO_SM_name_size_c+1],            
    tag_t*           media_tag                                      
    );

extern OBJIO_API int OBJIO_SM_create_media2(
    char             *media_name,             
    char             *logical_device,         
    char             *media_type,             
    tag_t*           media_tag                
    );

extern OBJIO_API int OBJIO_SM_set_media_name(
    tag_t            media_tag,                         
    char             media_name[OBJIO_SM_name_size_c+1] 
    );


extern OBJIO_API int OBJIO_SM_set_media_name2(
    tag_t            media_tag,                         
    char             *media_name                        
    );

extern OBJIO_API int OBJIO_SM_set_logical_device(
    tag_t            media_tag,                                     
    char             logical_device[OBJIO_SM_description_size_c+1]  
    );


extern OBJIO_API int OBJIO_SM_set_logical_device2(
    tag_t            media_tag,                                     
    char             *logical_device                                
    );

extern OBJIO_API int OBJIO_SM_set_description(
    tag_t            media_tag,                                 
    char             description[OBJIO_SM_description_size_c+1] 
    );


extern OBJIO_API int OBJIO_SM_set_description2(
    tag_t            media_tag,                                 
    char             *description                               
    );

extern OBJIO_API int OBJIO_SM_set_media_type(
    tag_t            media_tag,                         
    char             media_type[OBJIO_SM_name_size_c+1] 
    );


extern OBJIO_API int OBJIO_SM_set_media_type2(
    tag_t            media_tag,                         
    char             *media_type                        
    );

extern OBJIO_API int OBJIO_SM_ask_media_name(
    tag_t            media_tag,                         
    char             media_name[OBJIO_SM_name_size_c+1] 
    );

extern OBJIO_API int OBJIO_SM_ask_media_name2(
    tag_t            media_tag,                         
    char             **media_name                       
    );

extern OBJIO_API int OBJIO_SM_ask_logical_device(
    tag_t            media_tag,                                     
    char             logical_device[OBJIO_SM_description_size_c+1]  
    );


extern OBJIO_API int OBJIO_SM_ask_logical_device2(
    tag_t            media_tag,                                     
    char             **logical_device                               
    );

extern OBJIO_API int OBJIO_SM_ask_description(
    tag_t            media_tag,                                 
    char             description[OBJIO_SM_description_size_c+1] 
    );


extern OBJIO_API int OBJIO_SM_ask_description2(
    tag_t            media_tag,                                 
    char             **description                              
    );

extern OBJIO_API int OBJIO_SM_ask_media_type(
    tag_t            media_tag,                         
    char             media_type[OBJIO_SM_name_size_c+1] 
    );


extern OBJIO_API int OBJIO_SM_ask_media_type2(
    tag_t            media_tag,                         
    char             **media_type                       
    );

extern OBJIO_API int OBJIO_SM_find_media(
    char             media_name[OBJIO_SM_name_size_c+1],    
    tag_t*           media_tag                              
    );


extern OBJIO_API int OBJIO_SM_find_media2(
    char             *media_name,                           
    tag_t*           media_tag                              
    );

extern OBJIO_API int OBJIO_SM_media_extent(
    int*             media_count,   
    tag_t**          media_tags     
    );

extern OBJIO_API int OBJIO_SM_ask_if_online(
    tag_t            media_tag,     
    logical*         online         
    );

extern OBJIO_API int OBJIO_SM_store(
    tag_t            media_tag,                         
    char             filename[OBJIO_SM_name_size_c+1],  
    char             source_dir[OBJIO_SM_name_size_c+1] 
    );


extern OBJIO_API int OBJIO_SM_store2(
    tag_t            media_tag,                         
    char             *filename,                         
    char             *source_dir                        
    );


extern OBJIO_API int OBJIO_SM_retrieve(
    tag_t            media_tag,                                 
    char             filename[OBJIO_SM_name_size_c+1],          
    char             destination_dir[OBJIO_SM_name_size_c+1]    
    );

extern OBJIO_API int OBJIO_SM_retrieve2(
    tag_t            media_tag,                                 
    char             *filename,                                 
    char             *destination_dir                           
    );


extern OBJIO_API int OBJIO_SM_store_files(
    tag_t            media_tag, 
    int              count,     
    tag_t*           tags_list  
    );


extern OBJIO_API int OBJIO_SM_retrieve_file(
    tag_t            media_tag, 
    tag_t            file_tag   
    );

extern OBJIO_API int OBJIO_SM_exists(
    tag_t            media_tag,                         
    char             filename[OBJIO_SM_name_size_c+1],  
    int*             doesnt_exist_flag                  
    );

extern OBJIO_API int OBJIO_SM_exists2(
    tag_t            media_tag,                         
    char             *filename,                         
    int*             doesnt_exist_flag                  
    );

#ifdef __cplusplus
}
#endif

#include <objio/libobjio_undef.h>

#endif