Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

Teamcenter File Cache
[Teamcenter File]

Data Structures

Defines

Typedefs

Enumerations

Functions


Define Documentation

#define NO_SECURITY   0

Definition at line 22 of file tcfile_cache.h.

#define SOCKET_MODE   1

Definition at line 23 of file tcfile_cache.h.


Typedef Documentation

Definition at line 42 of file tcfile_cache.h.


Enumeration Type Documentation

Enumerator:
FC_cache 
FC_temp 
FC_volume 

Definition at line 25 of file tcfile_cache.h.


Function Documentation

SA_API int IMF_fms_get_file_access ( tag_t  file_tag,
int  date_offset,
logical  using_fms,
IMF_file_data_p_t file_data 
)

FMS-aware version of IMF_get_file_access() (see above)

Parameters:
file_tag  (I)
date_offset  (I)
using_fms  (I)
file_data  (O)

SA_API int IMF_fms_get_filename ( IMF_file_data_p_t  file_data,
logical  using_fms,
char **  osfilename,
char **  read_ticket,
logical is_transient,
char **  orig_file_name 
)

FMS-aware version of IMF_get_filename() (see above)

Parameters:
file_data  (I)
using_fms  (I)
osfilename  (O)
read_ticket  (O)
is_transient  (O)
orig_file_name  (O)

SA_API int IMF_get_cache_size ( float *  cache_size  ) 

Parameters:
cache_size  (0)

SA_API int IMF_get_file_access ( tag_t  file_tag,
int  date_offset,
IMF_file_data_p_t file_data 
)

This function returns a pointer to an IMF_file_data_p_t structure that will be used by the routine IMF_get_filename. The purpose of the function is to provide access to the file referenced by the file_tag. The date_offset value is the time in seconds after January 1, 1970 that the modification date of the file should be set to. If you don’t care what the modification date of the file is set to, use a date_offset value of zero.

Parameters:
file_tag  (I)
date_offset  (I)
file_data  (O)

SA_API int IMF_get_filename ( IMF_file_data_p_t  file_data,
char **  osfilename 
)

This function returns a pointer to a string to which the user has read access. The input parameter is retrieved with a call to IMF_get_file_access.

Parameters:
file_data  (I)
osfilename  (O)

SA_API void IMF_initialize_file_cache (  ) 

SA_API int IMF_release_file_access ( IMF_file_data_p_t file_data  ) 

This function is used to release any memory created by the call to IMF_get_file_access. It also either sets the protection of files in the volumes back to no access or deletes any temporary files that were created. The input parameter is retrieved with a call to IMF_get_file_access.

Parameters:
file_data  (I/O)

SA_API int IMF_update_cache_size ( float  bytes_to_add,
float *  cache_size 
)

Parameters:
bytes_to_add  (I)
cache_size  (0)