collection.h

Go to the documentation of this file.

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CORE_COLLECTION_H_INCLUDED_
#define PDFSDK_CORE_COLLECTION_H_INCLUDED_
 
#include <pdfsdk/core/api_macro.h>
#include <pdfsdk/core/atoms.h>
#include <pdfsdk/core/document.h>
#include <pdfsdk/errors.h>
#include <pdfsdk/math_types.h>
#include <pdfsdk/progress_monitor.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct PDCollectionRec_* PDCollection;
 
typedef struct {
    PDAtom name;
    PDAtom subtype;
    wchar_t* fieldName;
    size_t fieldNameLength;
    bool isVisible;
    bool isEditable;
} PDSchemaFieldRecord;
 
typedef struct {
    PDAtom fieldName;
    bool isAscending;
} PDCollectionSortRecord;
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCollectionGetInitialDocument(PDCollection collection, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCollectionSetInitialDocument(PDCollection collection, const wchar_t* buffer, size_t bufSize);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCollectionSetViewMode(PDCollection collection, PDAtom view);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCollectionGetViewMode(PDCollection collection, PDAtom* view);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetCollection(PDDoc doc, PDCollection* pCollection);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateCollection(PDDoc doc, PDCollection* pCollection);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCollectionRemoveSchemaFieldRecord(PDCollection collection, PDAtom schemaFieldName);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCollectionAddSchemaFieldRecord(PDCollection collection, const PDSchemaFieldRecord* schemaRecord, const int* order);
// PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCollectionGetSchemaRecord(PDCollection collection, PDSchemaFieldRecord* schemaRecord, const int* order);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCollectionGetSortRecord(PDCollection collection, PDCollectionSortRecord* sortRec, size_t bufferSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCollectionSetSortRecord(PDCollection collection, const PDCollectionSortRecord* sortRec, size_t bufferSize);
 
#ifdef __cplusplus
}
#endif
 
#endif  // PDFSDK_CORE_COLLECTION_H_INCLUDED_