ShiProperties.h

Go to the documentation of this file.

/*****************************************************************
|
|   Sushi - Properties
|
|   $Id: ShiProperties.h 7930 2014-06-25 11:05:10Z jebaseelir $
|   Original author:  Gilles Boccon-Gibod
|
|   This software is provided to you pursuant to your agreement 
|   with Intertrust Technologies Corporation ("Intertrust"). 
|   This software may be used only in accordance with the terms 
|   of the agreement.
|      
|   Copyright (c) 2005-2014 by Intertrust. All rights reserved. 
|
****************************************************************/
#ifndef _SHI_PROPERTIES_H_
#define _SHI_PROPERTIES_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "ShiResults.h"
#include "ShiTypes.h"
#include "ShiInterfaces.h"
#include "ShiData.h"

/*----------------------------------------------------------------------
|   interfaces
+---------------------------------------------------------------------*/
#if defined(__cplusplus)
extern "C" {
#endif

typedef struct SHI_Properties SHI_Properties;

SHI_PUBLIC_API
SHI_Result
SHI_Properties_GetProperty(SHI_Properties* self, 
                           const char*     name,
                           SHI_DataType    type,
                           SHI_Data**      property);

SHI_PUBLIC_API
SHI_Result
SHI_Properties_SetProperty(SHI_Properties*      self, 
                           const char*          name, 
                           SHI_DataType         type,
                           const SHI_DataValue* value);

SHI_PUBLIC_API
SHI_Cardinal
SHI_Properties_GetPropertyCount(SHI_Properties* self);

SHI_PUBLIC_API
SHI_Result
SHI_Properties_GetPropertyNames(SHI_Properties* self, SHI_Data** names);

#if defined(__cplusplus)
}
#endif

#endif /* _SHI_PROPERTIES_H_ */