lcn_fielddata.h

Go to the documentation of this file.

/* Copyright 2005 The Apache Software Foundation or its licensors, as
 * applicable.
 *
 * 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.
 */

/**
 * @file lcn_fielddata.h
 * @brief Routines for manipulating a segment's field data file
 */

#ifndef _LCN_FIELDDATA_H
#define _LCN_FIELDDATA_H

#include "lcn_types.h"
#include "lcn_directory.h"
#include "lcn_field.h"

#include <apr_tables.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** Opaque structure representing a segment's field data. */
typedef struct lcn_fielddata_t lcn_fielddata_t;

/** Return the field data @a fd for segment @a s in directory @a d, allocated
 * within @a pool.
 */
lcn_error_t *
lcn_fielddata_open (lcn_fielddata_t **fd,
                    const lcn_directory_t *d,
                    const lcn_char_t *s,
                    apr_pool_t *pool);

/** Returns in @a doc an array of @c lcn_field_t pointers associated with
 * document number @a doc_num, allocated within @a pool.
 */
lcn_error_t *
lcn_fielddata_get_doc (apr_array_header_t **doc,
                       lcn_fielddata_t *fd,
                       apr_uint32_t doc_num,
                       apr_pool_t *pool);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif

---