vis_user_exit.h

Go to the documentation of this file.

/*
    Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
    ==================================================
    Copyright 2015.
    Siemens Product Lifecycle Management Software Inc.
    All Rights Reserved.
    ==================================================
    Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
*/

#ifndef VIS_USER_EXIT_H
#define VIS_USER_EXIT_H

#include <unidefs.h>

#include <vis/libvis_exports.h>

#define USER_VIS_get_metadata_filename_msg           "BMF_USER_VIS_get_metadata_filename"

#define USER_VIS_get_metadata_filename_context_msg   "BMF_USER_VIS_get_metadata_filename_context"

#define USER_VIS_get_basedocument_msg                "BMF_USER_VIS_get_basedocument"


typedef struct VIS_additional_keyvalue_s
{
      char* key;             
      char* value;           
} VIS_additional_keyvalue_t,*VIS_additional_keyvalue_p_t;

typedef struct VIS_object_input_s
{
    tag_t   object;                                 
    int     n_context_tags;                         
    tag_t*  context_tags;                           
    int       n_key_value;                          
    VIS_additional_keyvalue_p_t   additional_info;  
} VIS_object_input_t, *VIS_object_input_p_t;

typedef struct VIS_basedoc_output_s
{
       tag_t     base_doc;                             
       tag_t     base_doc_item;                        
       tag_t     base_doc_itemrev;                     
       int       n_key_value;                          
       VIS_additional_keyvalue_p_t   additional_info;  
} VIS_basedoc_output_t, *VIS_basedoc_output_p_t;



#ifdef __cplusplus
    extern "C"{
#endif

extern VIS_API int USER_VIS_get_metadata_filename (
    tag_t                     object,           
    char**                    mds_file_path     
    );

    
extern VIS_API int USER_VIS_get_metadata_filename_context (
    tag_t                     object,           
    tag_t                     context,          
    char**                    mds_file_path     
    );


extern VIS_API int USER_VIS_get_base_document (
    const VIS_object_input_p_t    vis_obj_struct,     
    VIS_basedoc_output_p_t*       base_doc_struct     
    );


#ifdef __cplusplus
}
#endif

#include <vis/libvis_undef.h>

#endif