/usr/include/axis2-1.6.0/axiom_xml_writer.h is in libaxis2c-dev 1.6.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 | /*
* Copyright 2004,2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef AXIOM_XML_WRITER_H
#define AXIOM_XML_WRITER_H
/**
*@file axiom_xml_writer.h
*@brief this is the parser abstraction layer for axis2
*/
#include <axutil_env.h>
#include <axiom_defines.h>
#ifdef __cplusplus
extern "C"
{
#endif
typedef struct axiom_xml_writer_ops axiom_xml_writer_ops_t;
typedef struct axiom_xml_writer axiom_xml_writer_t;
/**
* @defgroup axiom_xml_writer XML writer
* @ingroup axiom_parser
* @{
*/
/**
* \brief axiom_xml_writer ops
* Encapsulator struct for ops of axiom_xml_writer
*/
struct axiom_xml_writer_ops
{
/**
* Free xml writer
* @param writer pointer to xml_writer struct to be freed
* @param env environment, MUST NOT be NULL.
* @returns status of the op.
* AXIS2_SUCCESS on success and AXIS2_FAILURE on error
*/
void(
AXIS2_CALL
* free)(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* Write a start tag to output stream with localname.
* Internally the writer keeps track of the opened tags
* @param writer pointer to xml writer struct
* @param env environment. MUST NOT be NULL.
* @param localname localname of the tag, May not be NULL.
* @return the status of the op, AXIS2_SUCCESS on success
AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_start_element)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname);
/**
* write an end tag to the output relying on the internal
* state of writer to determine the prefix and localname of
* the element
* @param writer xml_writer struct
* @param env environment, MUST NOT be NULL.
* @return status of the op. AXIS2_SUCCESS on success.
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* end_start_element)(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* Write an element tag with localname and namespace uri
* @param writer pointer to xml writer struct
* @param env environment struct
* @param localname localname of the tag, May not be null.
* @param namespace_uri the namespace URI of the the pefix
* to use.may not be null.
* @returns status of the op, AXIS2_SUCCESS on success.
* AXIS2_FAILURE on error
*/
axis2_status_t(
AXIS2_CALL
* write_start_element_with_namespace)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * namespace_uri);
/**
* write a start tag to output
* @param writer pointer to xml_writer struct
* @param environment, MUST NOT be NULL.
* @param localname localname of the tag, May not be null.
* @param namespace_uri namespace to bind the prefix to
* @param prefix the prefix to the tag.May not be NULL.
* @return status of the op
AXIS2_SUCCESS on success. AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_start_element_with_namespace_prefix)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * namespace_uri,
axis2_char_t * prefix);
/**
* write an element tag with localname
* @param writer xml_writer
* @param env environment
* @param localname localname
* @return status of the op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_empty_element)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname);
/**
* write empty_element with localname and namespace uri.
* @param writer xml writer
* @param env environment
* @param localname localname
* @param namespace uri
* @return status of the op, AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_empty_element_with_namespace)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * namespace_uri);
/**
* write empty element with namespace uri and prefix
* @param writer xml_writer
* @param env environment
* @param localname localname
* @param namespace_uri namespace uri
* @param prefix prefix
* @return status of the op, AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_empty_element_with_namespace_prefix)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * namespace_uri,
axis2_char_t * prefix);
/**
* write end tag with correct localname prefix resolved internally
* @param writer xml writer
* @param env environment
* @return status of the op, AXIS2_SUCCESS on success,
* AXIS2_FAILURE on failure
*/
axis2_status_t(
AXIS2_CALL
* write_end_element)(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* write end document
* @param writer xml writer
* @param env environment
* @return status of the op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_end_document)(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* write attribute with localname and value
* @param writer writer
* @param env environment
* @param localname localname
* @param value text value of attribute
* @return status of the op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_attribute)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * value);
/**
* @param writer
* @param env environment
* @param localname
* @param value text value of attribute
* @param namespace uri namespace uri
* @return status code of the op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_attribute_with_namespace)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * value,
axis2_char_t * namespace_uri);
/**
* @param writer xml_writer
* @param env environment
* @param localname localname
* @param value text value of attribute
* @param namespace uri namespaceuri
* @param prefix prefix
*/
axis2_status_t(
AXIS2_CALL
* write_attribute_with_namespace_prefix)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * value,
axis2_char_t * namespace_uri,
axis2_char_t * prefix);
/**
* @param writer xml_writer
* @param env environment
* @param prefix prefix
* @param namespace uri namespaceuri
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_namespace)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * prefix,
axis2_char_t * namespace_uri);
/**
* @param writer xml_writer
* @param env environment
* @param namespace uri namespaceuri
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_default_namespace)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * namespace_uri);
/**
* @param writer xml_writer
* @param env environment
* @param value value
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_comment)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * value);
/**
* @param writer xml_writer
* @param env environment
* @param target pi target
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_processing_instruction)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * target);
/**
* @param writer xml_writer
* @param env environment
* @param target pi target
* @param data pi data
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_processing_instruction_data)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * target,
axis2_char_t * data);
/**
* @param writer xml_writer
* @param env environment
* @param data cdata
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_cdata)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * data);
/**
* @param writer xml_writer
* @param env environment
* @param dtd dtd
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_dtd)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * dtd);
/**
* @param writer xml_writer
* @param env environment
* @param name name
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_entity_ref)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * name);
/**
* @param writer xml_writer
* @param env environment
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_start_document)(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* @param writer xml_writer
* @param env environment
* @param version version
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_start_document_with_version)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * version);
/**
* @param writer xml_writer
* @param env environment
* @param version version
* @param encoding encoding
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_start_document_with_version_encoding)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * version,
axis2_char_t * encoding);
/**
* @param writer xml_writer
* @param env environment
* @param text text
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_characters)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * text);
/**
* @param writer xml_writer
* @param env environment
* @param uri uri
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_char_t *(
AXIS2_CALL
* get_prefix)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * uri);
/**
* @param writer xml_writer
* @param env environment
* @param prefix prefix
* @param uri uri
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* set_prefix)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * prefix,
axis2_char_t * uri);
/**
* @param writer xml_writer
* @param env environment
* @param uri uri
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* set_default_prefix)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * uri);
/**
* @param writer xml_writer
* @param env environment
* @param text text
* @param in_attr
* @return status of op AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
axis2_status_t(
AXIS2_CALL
* write_encoded)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * text,
int in_attr);
void *(
AXIS2_CALL
* get_xml)(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
unsigned int(
AXIS2_CALL
* get_xml_size)(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
int(
AXIS2_CALL
* get_type)(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
axis2_status_t(
AXIS2_CALL
* write_raw)(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * content);
axis2_status_t(
AXIS2_CALL
* flush)(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
};
/**
* @brief axis2_pull_parser struct
* Axis2 OM pull_parser
*/
struct axiom_xml_writer
{
const axiom_xml_writer_ops_t *ops;
};
/**
* create function for axiom_xml_writer
* @param env environment
* @param filename filename
* @param encoding encoding
* @param is_prefix_default
* @param compression
* return xml writer wrapper structure
*/
AXIS2_EXTERN axiom_xml_writer_t *AXIS2_CALL
axiom_xml_writer_create(
const axutil_env_t * env,
axis2_char_t * filename,
axis2_char_t * encoding,
int is_prefix_default,
int compression);
/**
* create fuction for xml writer for memory buffer
* @param env environment struct, must not be null
* @param env environment
* @param encoding encoding
* @param is_prefix_default
* @param compression
* @return xml writer wrapper structure.
*/
AXIS2_EXTERN axiom_xml_writer_t *AXIS2_CALL
axiom_xml_writer_create_for_memory(
const axutil_env_t * env,
axis2_char_t * encoding,
int is_prefix_default,
int compression,
int type);
/**
* free method for axiom xml writer
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_xml_writer_free(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
* @param localname local name of the start element
* @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_start_element(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_end_start_element(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_start_element_with_namespace(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * namespace_uri);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
* @param localname localname of the start element
* @param namespace_uri namespace uri of that element
* @param prefix prefix of that namespace
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_start_element_with_namespace_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * namespace_uri,
axis2_char_t * prefix);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
* @param localname local name of the element
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_empty_element(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
* @param localname local name of the element
* @param namespace_uri uri of the namespace
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_empty_element_with_namespace(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * namespace_uri);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
* @param localname local name of the element
* @param namespace_uri uri of the namespace
* @param prefix prefix of the namespace
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_empty_element_with_namespace_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * namespace_uri,
axis2_char_t * prefix);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_end_element(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_end_document(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
* @param localname local name of the element
* @param value value of the element
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_attribute(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * value);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
* @param localname local name of the element
* @param value value of the element
* @param uri of the namespace
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_attribute_with_namespace(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * value,
axis2_char_t * namespace_uri);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
* @param localname local name of the element
* @param value value of the element
* @param uri of the namespace
* @param prefix of the namespace
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_attribute_with_namespace_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * value,
axis2_char_t * namespace_uri,
axis2_char_t * prefix);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
* @param prefix prefix of the namespace
* @param uri of the namespace
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_namespace(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * prefix,
axis2_char_t * namespace_uri);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_default_namespace(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * namespace_uri);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_comment(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * value);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_processing_instruction(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * target);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_processing_instruction_data(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * target,
axis2_char_t * data);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_cdata(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * data);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_dtd(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * dtd);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_entity_ref(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * name);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_start_document(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_start_document_with_version(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * version);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_start_document_with_version_encoding(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * version,
axis2_char_t * encoding);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_characters(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * text);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_xml_writer_get_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * uri);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return prefix
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_set_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * prefix,
axis2_char_t * uri);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_set_default_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * uri);
/**
* sets the default prefix
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_encoded(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * text,
int in_attr);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return
*/
AXIS2_EXTERN void *AXIS2_CALL
axiom_xml_writer_get_xml(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return
*/
AXIS2_EXTERN unsigned int AXIS2_CALL
axiom_xml_writer_get_xml_size(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return size of the xml
*/
AXIS2_EXTERN int AXIS2_CALL
axiom_xml_writer_get_type(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return type
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_raw(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * content);
/**
* @param writer pointer to the OM XML Writer struct
* @param env environment struct, must not be null
*
* @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_flush(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIOM_XML_WRITER_H */
|