dsapi_attr.h

Go to the documentation of this file.

/* Emacs mode: -*- C -*- */
 
/* 
 * Copyright (c) 2004-2010, Isode Limited, London, England.
 * All rights reserved.
 *
 * Acquisition and use of this software and related materials for any
 * purpose requires a written licence agreement from Isode
 * Limited, or a written licence from an organisation licenced by Isode
 * Limited to grant such a licence.
 *
 */
 
/*
 * dsapi_attr.h
 *
 * Directory client API methods for manipulating entry attributes.
 *
 */
 
/* 
 * 
 *
 * @VERSION@
 */
 
#ifndef ISODE_DSAPI_ATTR_H
#define ISODE_DSAPI_ATTR_H
 
#include <stddef.h>
#include <isode/ds/dsapi/dsapi_cdecl.h>
#include <isode/ds/dsapi/dsapi_types.h>
#include <isode/ds/dsapi/dsapi_const.h>
 
LIBDSAPI_CDECL
DS_Status DS_Entry_GetNamedAttr (
    const DS_Entry  *entry,
    const char      *type,
    const DS_Attr  **attr_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Entry_GetAttrList (
    const DS_Entry     *entry,
    const DS_AttrList **attr_list_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Entry_GetModList (
    const DS_Entry     *entry,
    const DS_AttrList **mod_list_p
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrList_New (
    DS_AttrList **attrlist_p,
    const DS_Attr *attr
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrList_Append (
    DS_AttrList *attrlist,
    const DS_Attr *attr
);
 
LIBDSAPI_CDECL
const DS_Attr *DS_AttrList_GetFirst (
    const DS_AttrList *attr_list
);
 
LIBDSAPI_CDECL
const DS_Attr *DS_AttrList_GetNext (
    const DS_Attr *attr
);
 
LIBDSAPI_CDECL
DS_Status DS_Attr_GetTypeName (
    const DS_Attr  *attr,
    const char    **str_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Attr_GetModType (
    const DS_Attr  *attr,
    DSModType      *type_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Attr_GetValueList (
    const DS_Attr         *attr,
    const DS_AttrValList **val_list_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Attr_AddStringValue (
    DS_Attr    *attr,
    const char *str,
    size_t      len
);
 
LIBDSAPI_CDECL
DS_Status DS_Attr_AddBERValue (
    DS_Attr             *attr,
    const unsigned char *ber,
    size_t               len
);
 
LIBDSAPI_CDECL
DS_Status DS_Attr_New (
    const char  *name,
    DS_Attr    **attr_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Attr_New_AllowUnknown (
    const char  *name,
    DS_Attr    **attr_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Attr_IsUnknown (
    DS_Attr    *attr,
    int        *is_unknown_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Attr_Copy (
    const DS_Attr  *attr,
    DS_Attr       **copy_p
);
 
LIBDSAPI_CDECL
void DS_Attr_Delete (
    DS_Attr *attr
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrList_Copy (
    const DS_AttrList  *attr_list,
    DS_AttrList       **copy_p
);
 
LIBDSAPI_CDECL
void DS_AttrList_Delete (
    DS_AttrList *attr_list
);
 
/* \} */
 
LIBDSAPI_CDECL
const DS_AttrVal *DS_AttrValList_GetFirst (
   const DS_AttrValList *value_list
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrValList_GetCount (
    const DS_AttrValList *value_list,
    int                  *count_p
);
 
LIBDSAPI_CDECL
const DS_AttrVal *DS_AttrValList_GetNext (
   const DS_AttrVal *value
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrVal_GetBERPointer (
    const DS_AttrVal     *value,
    const unsigned char **ber_ptr_p,
    size_t               *ber_len_p
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrVal_GetStringPointer (
    const DS_AttrVal  *value,
    const char       **str_p,
    size_t            *str_len_p
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrVal_GetInternal (
    const DS_AttrVal *value,
    const void       **ir_p
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrVal_Internal_Delete (
    const DS_AttrVal *value,
    void             *ir
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrVal_Normalize (
    const DS_AttrVal *value
);
 
 
LIBDSAPI_CDECL
DS_Status DS_AttrVal_RegenerateBER (
    const DS_AttrVal  *value,
    DS_AttrVal       **copy_p
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrVal_Compare (
    const DS_AttrVal  *av1,
    const DS_AttrVal  *av2,
    int               *res_p
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrVal_Copy (
    const DS_AttrVal  *av,
    DS_AttrVal       **copy_p
);
 
LIBDSAPI_CDECL
void DS_AttrVal_Delete (
    DS_AttrVal *av
);
 
LIBDSAPI_CDECL
DS_Status DS_AttrValList_Copy (
    const DS_AttrValList  *av_list,
    DS_AttrValList       **copy_p
);
 
LIBDSAPI_CDECL
void DS_AttrValList_Delete (
    DS_AttrValList *av_list
);
 
#endif /* ISODE_DSAPI_ATTR_H */