tcvolume.h

Go to the documentation of this file.

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

/*  */

#ifndef TCVOLUME_H
#define TCVOLUME_H

#include <tc/tc_startup.h>
#include <ss/ss_const.h>
#include <sa/libsa_exports.h>

#define VM_node_size_c  32
#define VM_path_size_c  SS_MAXPATHLEN
#define VM_name_size_c  32
#define VM_TCP_ACCESS    1
#define VM_FMS_ACCESS    1
#define VM_NO_SECURITY   2

#ifdef __cplusplus
extern "C"{
#endif

extern SA_API int VM_extent(
    int*          n_instances,  
    tag_t**       instances     
    );

extern SA_API int VM_find(
    const char    volume_name[VM_name_size_c + 1],  
    tag_t*        volume                            
    );

extern SA_API int VM_find2(
    const char    *volume_name,                     
    tag_t*        volume                            
    );

extern SA_API int VM_find_by_path(
    const char    path[VM_path_size_c + 1], 
    int           machine_type,             
    tag_t*        volume                    
    );

extern SA_API int VM_find_by_path2(
    const char    *path,                    
    int           machine_type,             
    tag_t*        volume                    
    );

extern SA_API int VM_ask_name(
    tag_t         volume,                           
    char          volume_name[VM_name_size_c + 1]   
    );

extern SA_API int VM_ask_name2(
    tag_t         volume,                           
    char          **volume_name                     
    );

extern SA_API int VM_ask_node_name(
    tag_t         volume,                           
    char          node_name[VM_node_size_c + 1]     
    );

extern SA_API int VM_ask_node_name2(
    tag_t         volume,                           
    char          **node_name                       
    );

extern SA_API int VM_ask_path(
    tag_t         volume,                   
    int           machine_type,             
    char          path[VM_path_size_c + 1]  
    );

extern SA_API int VM_ask_path2(
    tag_t         volume,                   
    int           machine_type,             
    char          **path                    
    );

extern SA_API int VM_ask_machine_type(
    tag_t         volume,       
    int*          machine_type  
    );

extern SA_API int VM_ask_access_mode(
    tag_t         volume,       
    int*          access_mode   
    );

extern SA_API int VM_grant_access(
    tag_t         volume,   
    tag_t         target    
    );

extern SA_API int VM_revoke_access(
    tag_t         volume,   
    tag_t         target    
    );

extern SA_API int VM_check_access(
    tag_t         volume,       
    tag_t         user,         
    int*          access_flag   
    );

extern SA_API int VM_ask_access_list(
    tag_t         volume,   
    int*          count,    
    tag_t**       tag_list  
    );

extern SA_API int VM_ask_current_volume(
    tag_t*        volume_tag    
    );

extern SA_API int VM_ask_current_local_volume(
    tag_t*        volume_tag    
    );

extern SA_API int VM_ask_current_local_volume_for_user(
    tag_t         user_tag,     
    tag_t*        volume_tag    
    );

extern SA_API int VM_ask_store_and_forward_enabled(
    logical*        enabled    
    );

extern SA_API int VM_set_current_volume(
    tag_t         volumeTag,    
    char*         volumeName    
    );

extern SA_API int VM_set_current_local_volume(
    tag_t         volumeTag,    
    char*         volumeName    
    );

extern SA_API int VM_expand_path(
    char*         oldpath,      
    char*         newpath       
    );

extern SA_API int VM_createEx(
    const char    volume_name[VM_name_size_c + 1],  
    const char    node_name[VM_node_size_c + 1],    
    const char*   pathnames[SS_NUM_MTYPES],         
    int           machine_type,                     
    tag_t*        volume                            
    );

extern SA_API int VM_createEx2(
    const char    *volume_name,                     
    const char    *node_name,                       
    const char **pathnames,                         
    int           machine_type,                     
    tag_t*        volume                            
    );

extern SA_API int VM_createExFMS(
    const char    volume_name[VM_name_size_c + 1],  
    const char    node_name[VM_node_size_c + 1],    
    const char*   pathnames[SS_NUM_MTYPES],         
    int           machine_type,                     
    const char*   fsc_path,                         /* <I> Obsolete.  A value of NULL is recommended. */
    const char*   fsc_name,                         /* <I> The name of the FSC that will serve this volume.  May be NULL. */
    const char*   filestore_group,                  /* <I> The name of the Filestore Group that will serve this volume.  May be NULL. */
    const char*   load_balancer,                    /* <I> The name of the Load Balancer that will serve this volume.  May be NULL. */
    tag_t*        volume                            
    );

extern SA_API int VM_createExFMS2(
    const char    *volume_name,                    
    const char    *node_name,                      
    const char    **pathnames,                     
    int           machine_type,                     
    const char*   fsc_path,                         /* <I> Obsolete.  A value of NULL is recommended. */
    const char*   fsc_name,                         /* <I> The name of the FSC that will serve this volume.  May be NULL. */
    const char*   filestore_group,                  /* <I> The name of the Filestore Group that will serve this volume.  May be NULL. */
    const char*   load_balancer,                    /* <I> The name of the Load Balancer that will serve this volume.  May be NULL. */
    tag_t*        volume                            
    );

extern SA_API int VM_initializeEx(
    tag_t         volume,                           
    const char    volume_name[VM_name_size_c + 1],  
    const char    node_name[VM_node_size_c + 1],    
    const char*   pathnames[SS_NUM_MTYPES],         
    int           machine_type                      
    );

extern SA_API int VM_initializeEx2(
    tag_t         volume,                           
    const char    *volume_name,                     
    const char    *node_name,                       
    const char **pathnames,                         
    int           machine_type                      
    );

extern SA_API int VM_modifyEx(
    tag_t         volume,                           
    const char    volume_name[VM_name_size_c + 1],  
    const char    node_name[VM_node_size_c + 1],    
    const char*   pathnames[SS_NUM_MTYPES],         
    int           machine_type                      
    );

extern SA_API int VM_modifyEx2(
    tag_t         volume,                           
    const char    *volume_name,                     
    const char    *node_name,                       
    const char **pathnames,                         
    int           machine_type                      
    );

extern SA_API int VM_moveEx(
    tag_t         volume,                           
    const char    node_name[VM_node_size_c + 1],    
    const char*   pathnames[SS_NUM_MTYPES],         
    int           machine_type                      
    );

extern SA_API int VM_moveEx2(
    tag_t         volume,                           
    const char    *node_name,                       
    const char  **pathnames,                        
    int           machine_type                      
    );

extern SA_API int VM_list_accessible_volumes(
    int*          n_instances,   
    tag_t**       instances      
    );

#ifdef __cplusplus
}
#endif

#include <sa/libsa_undef.h>

#endif