/usr/include/freeipmi/fiid/fiid.h is in libfreeipmi-dev 0.8.12-3ubuntu1.
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 | /*
Copyright (C) 2003-2010 FreeIPMI Core Team
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef _FIID_H
#define _FIID_H 1
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
/*
* FIID Error Codes
*/
enum fiid_err
{
FIID_ERR_SUCCESS = 0,
FIID_ERR_OBJ_NULL = 1,
FIID_ERR_OBJ_INVALID = 2,
FIID_ERR_ITERATOR_NULL = 3,
FIID_ERR_ITERATOR_INVALID = 4,
FIID_ERR_PARAMETERS = 5,
FIID_ERR_TEMPLATE_INVALID = 6,
FIID_ERR_FIELD_NOT_FOUND = 7,
FIID_ERR_KEY_INVALID = 8,
FIID_ERR_FLAGS_INVALID = 9,
FIID_ERR_TEMPLATE_NOT_BYTE_ALIGNED = 10,
FIID_ERR_FIELD_NOT_BYTE_ALIGNED = 11,
FIID_ERR_BLOCK_NOT_BYTE_ALIGNED = 12,
FIID_ERR_OVERFLOW = 13,
FIID_ERR_MAX_FIELD_LEN_MISMATCH = 14,
FIID_ERR_KEY_FIELD_MISMATCH = 15,
FIID_ERR_FLAGS_FIELD_MISMATCH = 16,
FIID_ERR_TEMPLATE_LENGTH_MISMATCH = 17,
FIID_ERR_DATA_NOT_BYTE_ALIGNED = 18,
FIID_ERR_REQUIRED_FIELD_MISSING = 19,
FIID_ERR_FIXED_LENGTH_FIELD_INVALID = 20,
FIID_ERR_DATA_NOT_AVAILABLE = 21,
FIID_ERR_NOT_IDENTICAL = 22,
FIID_ERR_OUT_OF_MEMORY = 23,
FIID_ERR_INTERNAL_ERROR = 24,
FIID_ERR_ERRNUMRANGE = 25
};
typedef enum fiid_err fiid_err_t;
/*
* FIID Field Maximum Key Length
*/
#define FIID_FIELD_MAX_KEY_LEN 256
/*
* FIID Field Flags
*
* FIID Field Requirement Flags
*
* REQUIRED
*
* The field in the template is required. For requests, if not set, a
* packet cannot be created. For responses, if not set, a packet is
* invalid.
*
* OPTIONAL
*
* The field in the template is not required. For requests, if not
* set, a packet can still be created. For responses, if not set, a
* packet is still valid.
*
* In a template field, either the REQUIRED or OPTIONAL flag must be
* specified.
*
* FIID Field Length Flags
*
* LENGTH_FIXED
*
* The number of bits that must be set in the field is fixed. It
* cannot be any other length.
*
* LENGTH_VARIABLE
*
* The number of bits that must be set in the field is variable in
* length.
*
* In a template field, either the LENGTH_FIXED or LENGTH_VARIABLE
* flag must be specified.
*
* FIID Field Misc Flags
*
* MAKES_PACKET_SUFFICIENT
*
* Used to indicate a sufficient set of fields, that if set, may allow
* a packet to be "sufficiently valid", despite other "required"
* fields not being set. Typically used in response packets to
* indicate the few fields necessary to be set for a payload to be
* accepted.
*/
#define FIID_FIELD_REQUIRED 0x00000001
#define FIID_FIELD_OPTIONAL 0x00000002
#define FIID_FIELD_REQUIRED_MASK 0x0000000F
#define FIID_FIELD_REQUIRED_FLAG(__flags) \
((__flags) & FIID_FIELD_REQUIRED_MASK)
#define FIID_FIELD_REQUIRED_FLAG_VALID(__flags) \
((FIID_FIELD_REQUIRED_FLAG (__flags) == FIID_FIELD_REQUIRED \
|| FIID_FIELD_REQUIRED_FLAG (__flags) == FIID_FIELD_OPTIONAL) ? 1 : 0)
#define FIID_FIELD_LENGTH_FIXED 0x00000010
#define FIID_FIELD_LENGTH_VARIABLE 0x00000020
#define FIID_FIELD_LENGTH_MASK 0x000000F0
#define FIID_FIELD_LENGTH_FLAG(__flags) \
((__flags) & FIID_FIELD_LENGTH_MASK)
#define FIID_FIELD_LENGTH_FLAG_VALID(__flags) \
((FIID_FIELD_LENGTH_FLAG (__flags) == FIID_FIELD_LENGTH_FIXED \
|| FIID_FIELD_LENGTH_FLAG (__flags) == FIID_FIELD_LENGTH_VARIABLE) ? 1 : 0)
#define FIID_FIELD_MAKES_PACKET_SUFFICIENT 0x00010000
/*
* fiid_field_t
*
* Defines a FIID field:
*
* max_field_len - maximum length of a field in bits
* key - field name
* flags - indicating field requirements
*
* An array of field's makes up a FIID template.
*/
typedef struct fiid_field
{
unsigned int max_field_len;
char key[FIID_FIELD_MAX_KEY_LEN];
unsigned int flags;
} fiid_field_t;
/*
* FIID Template
*
* An array of fiid_field_t's make up a fiid template. The array should be
* terminated with a field with a maximum field length of 0.
*
* The FIID template should be a multiple of 8 (i.e. byte aligned) otherwise
* most of the FIID API will return errors.
*/
typedef fiid_field_t fiid_template_t[];
typedef struct fiid_obj *fiid_obj_t;
typedef struct fiid_iterator *fiid_iterator_t;
/*****************************
* FIID Template API *
*****************************/
/*
* fiid_template_field_lookup
*
* Returns 1 if the field is found in the template, 0 if not, -1 on
* error.
*/
int fiid_template_field_lookup (fiid_template_t tmpl,
const char *field);
/*
* FIID_TEMPLATE_FIELD_LOOKUP
*
* Returns 1 if the field is found in the template, -1 on error.
* Identical to fiid_template_field_lookup() except a return of 0 is
* not possible. If the field is not found, -1 is returned and
* errno EINVAL is the error code set.
*/
int FIID_TEMPLATE_FIELD_LOOKUP (fiid_template_t tmpl,
const char *field);
/*
* fiid_template_len
*
* Returns the total length (in bits) of the all the fields in the
* template, -1 on error.
*/
int fiid_template_len (fiid_template_t tmpl);
/*
* fiid_template_len_bytes
*
* Returns the total length (in bytes) of the all the fields in the
* template, -1 on error. Will return an error if template bit length
* is not a multiple of 8.
*/
int fiid_template_len_bytes (fiid_template_t tmpl);
/*
* fiid_template_field_start
*
* Returns the offset (in bits) of the beginning of the field within
* this template, -1 on error.
*/
int fiid_template_field_start (fiid_template_t tmpl,
const char *field);
/*
* fiid_template_field_start_bytes
*
* Returns the offset (in bytes) of the beginning of the field within
* this template, -1 on error. Will return an error if field bit
* offset is not a multiple of 8.
*/
int fiid_template_field_start_bytes (fiid_template_t tmpl,
const char *field);
/*
* fiid_template_field_end
*
* Returns the offset (in bits) of the ending of the field within this
* template, -1 on error.
*/
int fiid_template_field_end (fiid_template_t tmpl,
const char *field);
/*
* fiid_template_field_end_bytes
*
* Returns the offset (in bytes) of the ending of the field within
* this template, -1 on error. Will return an error if field bit
* offset is not a multiple of 8.
*/
int fiid_template_field_end_bytes (fiid_template_t tmpl,
const char *field);
/*
* fiid_template_field_len
*
* Returns the maximum length (in bits) of the specified field, -1 on
* error.
*/
int fiid_template_field_len (fiid_template_t tmpl,
const char *field);
/*
* fiid_template_field_len_bytes
*
* Returns the maximum length (in bytes) of the specified field, -1 on
* error. Will return an error if the field maximum bit length is not
* a multiple of 8.
*/
int fiid_template_field_len_bytes (fiid_template_t tmpl,
const char *field);
/*
* fiid_template_block_len
*
* Returns the maximum length (in bits) of the block of fields
* beginning at 'field_start' and ending at 'field_end'. Returns -1
* on error.
*/
int fiid_template_block_len (fiid_template_t tmpl,
const char *field_start,
const char *field_end);
/*
* fiid_template_block_len_bytes
*
* Returns the maximum length (in bytes) of the block of fields
* beginning at 'field_start' and ending at 'field_end'. Returns -1
* on error. Will return an error if the calculated bit length is not
* a multiple of 8.
*/
int fiid_template_block_len_bytes (fiid_template_t tmpl,
const char *field_start,
const char *field_end);
/*
* fiid_template_compare
*
* Returns 1 if the two specified templates are identical, 0 if not,
* -1 on error.
*/
int fiid_template_compare (fiid_template_t tmpl1,
fiid_template_t tmpl2);
/*
* FIID_TEMPLATE_COMPARE
*
* Returns 1 if the two specified templates are identical, -1 on
* error. Identical to fiid_template_compare() except a return of 0
* is not possible. If templates are not identical, -1 is returned and
* errno EINVAL is the error code set.
*/
int FIID_TEMPLATE_COMPARE (fiid_template_t tmpl1,
fiid_template_t tmpl2);
/*
* fiid_template_free
*
* Free's a template created by fiid_obj_template.
*/
void fiid_template_free (fiid_field_t *tmpl_dynamic);
/*****************************
* FIID Object API *
*****************************/
/*
* fiid_strerror
*
* Return statically allocated string describing the specified error.
*/
char *fiid_strerror (fiid_err_t errnum);
/*
* fiid_obj_create
*
* Return a fiid object based on the specified template. Returns NULL
* on error.
*/
fiid_obj_t fiid_obj_create (fiid_template_t tmpl);
/*
* fiid_obj_destroy
*
* Destroy and free memory from a fiid object.
*/
void fiid_obj_destroy (fiid_obj_t obj);
/*
* fiid_obj_dup
*
* Create and return a duplicate object from the one specified.
* Returns NULL on error.
*/
fiid_obj_t fiid_obj_dup (fiid_obj_t src_obj);
/*
* fiid_obj_copy
*
* Create and return a duplicate object from the one specified, but
* base the new object on the alternate template specified. Template
* length of the original and alternate template must be the same.
* Returns NULL on error.
*/
fiid_obj_t fiid_obj_copy (fiid_obj_t src_obj, fiid_template_t alt_tmpl);
/*
* fiid_obj_valid
*
* Returns 1 if the object passed in is a valid fiid object, 0 if not.
*/
int fiid_obj_valid (fiid_obj_t obj);
/*
* fiid_obj_packet_valid
*
* Returns 1 if the object contains all the data for a valid packet,
* 0 if not, -1 on error. A valid packet is based on the field flags
* specified in the original fiid template. For example, this
* function will check if all required fields have been set with the
* correct number of bytes. It will also check that data set within
* the object is byte aligned. The FIID_FIELD_MAKES_PACKET_SUFFICIENT
* is not considered in this function.
*/
int fiid_obj_packet_valid (fiid_obj_t obj);
/*
* FIID_OBJ_PACKET_VALID
*
* Returns 1 if the object contains all the data for a valid packet,
* -1 on error. Identical to fiid_obj_packet_valid() except a return
* of 0 is not possible. The FIID_FIELD_MAKES_PACKET_SUFFICIENT is
* not considered in this function.
*/
int FIID_OBJ_PACKET_VALID (fiid_obj_t obj);
/*
* fiid_obj_packet_sufficient
*
* Returns 1 if the object contains all the data for a sufficient
* packet, 0 if not, -1 on error. Identical to
* fiid_obj_packet_valid() except FIID_FIELD_MAKES_PACKET_SUFFICIENT
* is considered. If a packet does not meet the conditions to pass
* fiid_obj_packet_valid(), sufficient fields are subsequently
* checked.
*/
int fiid_obj_packet_sufficient (fiid_obj_t obj);
/*
* FIID_OBJ_PACKET_SUFFICIENT
*
* Returns 1 if the object contains a all the data for a valid packet,
* -1 on error. Identical to fiid_obj_packet_sufficient() except a return
* of 0 is not possible.
*/
int FIID_OBJ_PACKET_SUFFICIENT (fiid_obj_t obj);
/*
* fiid_obj_template
*
* Create a template based on what is stored internally within the
* object. Returns NULL on error. Free the resulting template using
* fiid_template_free().
*/
fiid_field_t *fiid_obj_template (fiid_obj_t obj);
/*
* fiid_obj_template_compare
*
* Returns 1 if the template specified is the one used to create the
* object, 0 if not, -1 one error.
*/
int fiid_obj_template_compare (fiid_obj_t obj, fiid_template_t tmpl);
/*
* FIID_OBJ_TEMPLATE_COMPARE
*
* Returns 1 if the template specified is the one used to create the
* object, -1 one error. Identical to fiid_obj_template_compare()
* except a return of 0 is not possible. If object template and input
* template are not identical, -1 is returned and
* FIID_ERR_NOT_IDENTICAL is the error code set.
*/
int FIID_OBJ_TEMPLATE_COMPARE (fiid_obj_t obj, fiid_template_t tmpl);
/*
* fiid_obj_errnum
*
* Returns the error code for the most recently occurring error.
*/
fiid_err_t fiid_obj_errnum (fiid_obj_t obj);
/*
* fiid_obj_errormsg
*
* Returns the error string for the most recently occurring error.
*/
char *fiid_obj_errormsg (fiid_obj_t obj);
/*
* fiid_obj_len
*
* Returns the total length (in bits) of data stored within the
* object, -1 on error.
*/
int fiid_obj_len (fiid_obj_t obj);
/*
* fiid_obj_len_bytes
*
* Returns the total length (in bytes) of data stored within the
* object, -1 on error. Will return an error if the total bit length
* of data is not a multiple of 8.
*/
int fiid_obj_len_bytes (fiid_obj_t obj);
/*
* fiid_obj_field_len
*
* Returns the length (in bits) of data stored within the
* specified field, -1 on error.
*/
int fiid_obj_field_len (fiid_obj_t obj, const char *field);
/*
* fiid_obj_field_len_bytes
*
* Returns the length (in bytes) of data stored within the specified
* field, -1 on error. Will return an error if the bit length of data
* is not a multiple of 8.
*/
int fiid_obj_field_len_bytes (fiid_obj_t obj, const char *field);
/*
* fiid_obj_block_len
*
* Returns the length (in bits) of data stored within the block of
* fields beginning at 'field_start' and ending at 'field_end'.
* Returns -1 on error.
*/
int fiid_obj_block_len (fiid_obj_t obj,
const char *field_start,
const char *field_end);
/*
* fiid_obj_block_len_bytes
*
* Returns the length (in bytes) of data stored within the block of
* fields beginning at 'field_start' and ending at 'field_end'.
* Returns -1 on error. Will return an error if the calculated bit
* length is not a multiple of 8.
*/
int fiid_obj_block_len_bytes (fiid_obj_t obj,
const char *field_start,
const char *field_end);
/*
* fiid_obj_clear
*
* Clear all data stored in the object. Return 0 on success, -1 on
* error.
*/
int fiid_obj_clear (fiid_obj_t obj);
/*
* fiid_obj_clear_field
*
* Clear all data stored in a specified field in the object. Return 0
* on success, -1 on error.
*/
int fiid_obj_clear_field (fiid_obj_t obj, const char *field);
/*
* fiid_obj_field_lookup
*
* Returns 1 if the field is found in the object, 0 if not, -1 on
* error.
*/
int fiid_obj_field_lookup (fiid_obj_t obj, const char *field);
/*
* FIID_OBJ_FIELD_LOOKUP
*
* Returns 1 if the field is found in the object, -1 on error.
* Identical to fiid_obj_field_lookup() except a return of 0 is not
* possible. If the field is not found, -1 is returned and
* FIID_ERR_FIELD_NOT_FOUND is the error code set.
*/
int FIID_OBJ_FIELD_LOOKUP (fiid_obj_t obj, const char *field);
/*
* fiid_obj_set
*
* Set data in the object for the specified field. Returns 0 on
* success, -1 on error.
*/
int fiid_obj_set (fiid_obj_t obj, const char *field, uint64_t val);
/*
* fiid_obj_get
*
* Get data stored in the object for the specified field. Returns 1
* if data was available and returned, 0 if no data was available, -1
* on error.
*/
int fiid_obj_get (fiid_obj_t obj, const char *field, uint64_t *val);
/*
* FIID_OBJ_GET
*
* Get data stored in the object for the specified field. Returns 1
* if data was available and returned, -1 on error. Identical to
* fiid_obj_get() except a return of 0 is not possible. If no data is
* available, -1 is returned and FIID_ERR_DATA_NOT_AVAILABLE is the
* error code set.
*/
int FIID_OBJ_GET (fiid_obj_t obj, const char *field, uint64_t *val);
/*
* fiid_obj_set_data
*
* Set an array of data in the object for the specified field.
* Returns length of data set on success, -1 on error. The field
* specified must begin on a byte boundary and have a maximum bit
* length that is a multiple of 8. Will truncate the data written
* if the field maximum length is smaller than the data given.
*/
int fiid_obj_set_data (fiid_obj_t obj,
const char *field,
const void *data,
unsigned int data_len);
/*
* fiid_obj_get_data
*
* Get an array of data in the object for the specified field.
* Returns length of data read on success, -1 on error. The field
* specified must begin on a byte boundary and have a data bit length
* that is a multiple of 8.
*/
int fiid_obj_get_data (fiid_obj_t obj,
const char *field,
void *data,
unsigned int data_len);
/*
* fiid_obj_set_all
*
* Set all fields in the object with the specified array of data.
* Returns length of data set on success, -1 on error. The given data
* must fall on a byte boundary of the object. Will truncate the data
* written if the total object maximum length is smaller than the data
* given. Will write as much as possible if data is not large enough
* to fill the entire object.
*/
int fiid_obj_set_all (fiid_obj_t obj, const void *data, unsigned int data_len);
/*
* fiid_obj_get_all
*
* Get an array of all data in the object. Returns length of data
* read on success, -1 on error.
*/
int fiid_obj_get_all (fiid_obj_t obj, void *data, unsigned int data_len);
/*
* fiid_obj_set_block
*
* Set a block of fields in the object, beginning with 'field_start'
* and ending with 'field_end'. Returns length of data set on
* success, -1 on error. The fields given must fall on a byte
* boundary of the object. Will truncate the data written if the
* total block maximum length is smaller than the data given. Will
* write as much as possible if data is not large enough to fill the
* entire block.
*/
int fiid_obj_set_block (fiid_obj_t obj,
const char *field_start,
const char *field_end,
const void *data,
unsigned int data_len);
/*
* fiid_obj_get_block
*
* Get a block of data in the object, beginning with 'field_start' and
* ending with 'field_end'. Returns length of data read on success,
* -1 on error. Data being read must fall on a byte boundary.
*/
int fiid_obj_get_block (fiid_obj_t obj,
const char *field_start,
const char *field_end,
void *data,
unsigned int data_len);
/*****************************
* FIID Iterator API *
*****************************/
/*
* fiid_iterator_create
*
* Create a fiid iterator to iteratate through each field in an
* object. Returns iterator on success, NULL on error.
*/
fiid_iterator_t fiid_iterator_create (fiid_obj_t obj);
/*
* fiid_iterator_destroy
*
* Destroy and free memory from a fiid iterator.
*/
void fiid_iterator_destroy (fiid_iterator_t iter);
/*
* fiid_iterator_errnum
*
* Returns the error code for the most recently occurring error.
*/
fiid_err_t fiid_iterator_errnum (fiid_iterator_t iter);
/*
* fiid_iterator_errormsg
*
* Returns the error string for the most recently occurring error.
*/
char *fiid_iterator_errormsg (fiid_iterator_t iter);
/*
* fiid_iterator_reset
*
* Reset the iterator back to the beginning. Returns 0 on success, -1
* on error.
*/
int fiid_iterator_reset (fiid_iterator_t iter);
/*
* fiid_iterator_next
*
* Move the iterator to the next field. Returns 0 on success, -1 on
* error.
*/
int fiid_iterator_next (fiid_iterator_t iter);
/*
* fiid_iterator_end
*
* Returns 1 if you are at the end of the iterator, 0 if not, -1
* error.
*/
int fiid_iterator_end (fiid_iterator_t iter);
/*
* fiid_iterator_field_len
*
* Returns the number of bits set for the current field. Returns -1
* on error.
*/
int fiid_iterator_field_len (fiid_iterator_t iter);
/*
* fiid_iterator_key
*
* Returns the key name for the current field. Returns NULL on error.
*/
char *fiid_iterator_key (fiid_iterator_t iter);
/*
* fiid_iterator_get
*
* Get data stored in the object for the current field. Returns 1
* if data was available and returned, 0 if no data was available, -1
* on error.
*/
int fiid_iterator_get (fiid_iterator_t iter, uint64_t *val);
/*
* fiid_iterator_get_data
*
* Get an array of data in the object for the current field. Returns
* length of data read on success, -1 on error. The current field
* must begin on a byte boundary and have a data bit length that is a
* multiple of 8.
*/
int fiid_iterator_get_data (fiid_iterator_t iter,
void *data,
unsigned int data_len);
#ifdef __cplusplus
}
#endif
#endif /* fiid.h */
|