tcfile.h

Go to the documentation of this file.

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

/*  */

#ifndef TCFILE_H
#define TCFILE_H

#include <pom/pom/pom.h>
#include <ss/ss_const.h>
#include <ss/ss_types.h>
#include <sa/libsa_exports.h>

#define IMF_filename_size_c           132
#define IMF_relative_path_size_c      240

#define IMF_dlp_classification_code_msg      "BMF_IMF_dlp_classification_code"

typedef void* IMF_file_t;
typedef  SS_file_status  IMF_file_status;



#ifdef __cplusplus
extern "C"{
#endif

extern SA_API int IMF_create_file(
    const char*   filename,         
    int           file_type,        
    tag_t*        file_tag,         
    IMF_file_t*   file_descriptor   
    );

extern SA_API int IMF_copy_file(
    tag_t         file_tag,         
    const char*   new_filename,     
    tag_t*        new_file_tag,     
    IMF_file_t*   file_descriptor   
    );

extern SA_API int IMF_import_file(
    const char*   osFileName,       
    const char*   newFilename,      
    int           fileType,         
    tag_t*        newFileTag,       
    IMF_file_t*   fileDescriptor    
    );

extern SA_API int IMF_export_file(
    tag_t         file_tag,     
    const char*   pathname      
    );

extern SA_API int IMF_ask_file_descriptor(
    tag_t         file_tag,         
    IMF_file_t*   file_descriptor   
    );

extern SA_API int IMF_ask_file_tag(
    IMF_file_t    file_descriptor,  
    tag_t*        file_tag          
    );

extern SA_API int IMF_ask_file_pathname(
    tag_t         file_tag,                 
    int           mach_type,                
    char          pathname[SS_MAXPATHLEN]   
    );

extern SA_API int IMF_ask_file_pathname2(
    tag_t         file_tag,                 
    int           mach_type,                
    char          **pathname                
    );

extern SA_API int IMF_open_file(
    IMF_file_t    file_descriptor,      
    int           ss_file_access_mode   
    );

extern SA_API int IMF_close_file(
    IMF_file_t    file_descriptor   
    );

extern SA_API int IMF_read_file_line(
    IMF_file_t    file_descriptor,          
    char          text_line[SS_MAXLLEN]     
    );

extern SA_API int IMF_read_file_line2(
    IMF_file_t    file_descriptor,          
    char          **text_line               
    );

extern SA_API int IMF_write_file_line(
    IMF_file_t    file_descriptor,          
    const char    text_line[SS_MAXLLEN]     
    );

extern SA_API int IMF_write_file_line2(
    IMF_file_t    file_descriptor,          
    const char    *text_line                
    );

extern SA_API int IMF_read_file(
    IMF_file_t    file_descriptor,      
    int           datatype_count,       
    int           data_type,            
    int*          items_read_count,     
    void*         items_read            
    );

extern SA_API int IMF_write_file(
    IMF_file_t    file_descriptor,      
    int           datatype_count,       
    int           data_type,            
    void*         items_to_write,       
    int*          items_written_count   
    );

extern SA_API int IMF_expand_path(
    const char*   oldpath,      
    char*         newpath       
    );

extern SA_API int IMF_stat(
    const char*         path,   
    IMF_file_status*    stats   
    );

extern SA_API int IMF_ask_security_level( void );

extern SA_API int IMF_ask_volume(
    tag_t         fileTag,      
    tag_t*        volumeTag     
    );

extern SA_API int IMF_move_file(
    tag_t         fileTag,      
    tag_t         volumeTag     
    );

extern SA_API int IMF_replace_file(
    tag_t         file_tag,                 
    const char*   new_file_pathname,        
    logical       retain_orig_filename      
    );

extern SA_API int IMF_replace_file_and_get_new_tag(
    tag_t         old_file_tag,             
    const char*   new_file_pathname,        
    logical       retain_orig_filename,     
    tag_t*        new_file_tag              
    );

extern SA_API int IMF_set_original_file_name (
    tag_t         file_tag,                         
    const char    name[IMF_filename_size_c + 1]     
    );


extern SA_API int IMF_set_original_file_name2 (
    tag_t         file_tag,                         
    const char    *name                             
    );


extern SA_API int IMF_ask_original_file_name (
    tag_t         file_tag,                         
    char          name[IMF_filename_size_c + 1]     
    );


extern SA_API int IMF_ask_original_file_name2 (
    tag_t         file_tag,                         
    char          **name                            
    );


extern SA_API int IMF_set_relative_path (
    tag_t         file_tag,                                     
    const char    relative_path[IMF_relative_path_size_c + 1]   
    );

extern SA_API int IMF_set_relative_path2 (
    tag_t         file_tag,                                     
    const char    *relative_path                                
    );

extern SA_API int IMF_ask_relative_path (
    tag_t         file_tag,                                     
    char          relative_path[IMF_relative_path_size_c + 1]   
    );

extern SA_API int IMF_ask_relative_path2 (
    tag_t         file_tag,                                     
    char          **relative_path                               
    );

extern SA_API int IMF_fmsfile_import(
    const char*   osFileName,       
    const char*   newFilename,      
    int           fileType,         
    tag_t*        newFileTag,       
    IMF_file_t*   fileDescriptor    
    );


extern SA_API int IMF_fmsfile_export(
    tag_t         file_tag,     
    const char*   pathname      
    );


extern SA_API int IMF_get_transient_file_read_ticket(
    int file_type,                                
    int server_mode,                              
    logical deleteSW,                             
    const char* transient_volume_file_path,       
    char** transient_volume_file_read_ticket      
    );

extern SA_API int IMF_get_transient_file_write_ticket(
    int file_type,                                
    int server_mode,                              
    const char* transient_volume_file_path,       
    char** transient_volume_file_write_ticket     
    );

extern SA_API int IMF_get_transient_volume_root_dir(
    int tier,                                     
    char** transientVolRootDir                    
    );

extern SA_API int IMF_get_absolute_transient_volume_file_path(
    int tier,                                     
    char*  ticket_string,                         
    char** ticket_file_path                       
    );

extern SA_API int IMF_get_read_file_tickets (
    int n_file_tags,                            
    const tag_t* file_tags,                     
    const char* application,                    
    int** ifails,                               
    char*** ticket_infos                        
    );

extern SA_API int IMF_download_file(
    const char*   read_ticket,  
    const char*   pathname      
    );

extern SA_API int IMF_dlp_classification_code(
    tag_t         file_tag,                     
    char*         file_classification_code      
    );

#ifdef __cplusplus
}
#endif

#include <sa/libsa_undef.h>

#endif