requirement.h

Go to the documentation of this file.

//Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
//==================================================
//Copyright $2014.
//Siemens Product Lifecycle Management Software Inc.
//All Rights Reserved.
//==================================================
//Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.

#ifndef REQUIREMENT_H
#define REQUIREMENT_H

#include <tc/tc_startup.h>
#include <req/libreq_exports.h>

#ifdef __cplusplus
    extern "C"{
#endif

#define REQ_export_as_ms_word_xml           "MSWordXML"

#define REQ_export_as_ms_word_xml_live      "MSWordXMLLive"

#define REQ_export_as_structure_contents    "StructureWithContents"

#define REQ_export_as_ms_word_markup        "ReqMarkupMgmt"

#define REQ_export_as_ms_word_markup_live   "ReqMarkupMgmtFN"

#define REQ_url_server_preference           "WEB_default_site_server"

#define REQ_url_protocol_preference         "WEB_protocol"

#define REQ_url_application_name            "WEB_default_site_deployed_app_name"


typedef struct
{
    char* option; 
    char* value;  
}REQ_importexport_options_t;

typedef enum REQ_content_types_e{ 
    REQ_HTML, 
    REQ_PLAINTEXT, 
    REQ_RICHTEXT 
}REQ_content_types_t; 


extern REQ_API int REQ_word_export(
        int size,                                          
        const tag_t* bom_lines,                            
        logical deep,                                      
        int document_type,                                 
        const char* specification_template,                
        int object_template_count,                         
        const char** bo_type,                              
        const char** object_template,                      
        int export_option_count,                           
        const REQ_importexport_options_t* export_options,  
        const char* mode_of_operation,                     
        char **document_location                           
);


extern REQ_API int REQ_excel_export(
            int object_count,                                 
            const tag_t* objects,                             
            int attribute_count,                              
            const char** attributes,                          
            const char* template_name,                        
            const char* application_format,                   
            int export_option_count,                          
            const REQ_importexport_options_t* export_options, 
            char**  file_path                                 
);


extern REQ_API int REQ_collect_markups(
        int     req_rev_count,                   
        const tag_t*  req_rev_list,              
        char**  markup_file_path                 
);

extern REQ_API int REQ_set_contents(
    tag_t rev_or_fulltext_tag,                  
    REQ_content_types_t content_type,           
    const char*  contents                       
);


#ifdef __cplusplus
}
#endif

#include <req/libreq_undef.h>
#endif