Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
ShiProperties.h
Go to the documentation of this file.
1 /*****************************************************************
2 |
3 | Sushi - Properties
4 |
5 | $Id: ShiProperties.h 7930 2014-06-25 11:05:10Z jebaseelir $
6 | Original author: Gilles Boccon-Gibod
7 |
8 | This software is provided to you pursuant to your agreement
9 | with Intertrust Technologies Corporation ("Intertrust").
10 | This software may be used only in accordance with the terms
11 | of the agreement.
12 |
13 | Copyright (c) 2005-2014 by Intertrust. All rights reserved.
14 |
15 ****************************************************************/
21 #ifndef _SHI_PROPERTIES_H_
22 #define _SHI_PROPERTIES_H_
23 
24 /*----------------------------------------------------------------------
25 | includes
26 +---------------------------------------------------------------------*/
27 #include "ShiResults.h"
28 #include "ShiTypes.h"
29 #include "ShiInterfaces.h"
30 #include "ShiData.h"
31 
32 /*----------------------------------------------------------------------
33 | interfaces
34 +---------------------------------------------------------------------*/
35 #if defined(__cplusplus)
36 extern "C" {
37 #endif
38 
52 
75  const char* name,
76  SHI_DataType type,
77  SHI_Data** property);
78 
97  const char* name,
98  SHI_DataType type,
99  const SHI_DataValue* value);
100 
110 
125 
127 #if defined(__cplusplus)
128 }
129 #endif
130 
131 #endif /* _SHI_PROPERTIES_H_ */
#define SHI_PUBLIC_API
Definition: ShiTypes.h:52
Result codes.
Interfaces.
SHI_PUBLIC_API SHI_Result SHI_Properties_GetProperty(SHI_Properties *self, const char *name, SHI_DataType type, SHI_Data **property)
Gets the value of a property.
Union of different possible types of values encapsulated by a SHI_Data object.
Definition: ShiData.h:90
SHI_DataType
Possible types of data in the value encapsulated by a SHI_Data object.
Definition: ShiData.h:37
SHI_UInt32 SHI_Cardinal
An unsigned integer used to represent a quantity that can be counted (such as a number of elements in...
Definition: ShiTypes.h:112
SHI_PUBLIC_API SHI_Result SHI_Properties_GetPropertyNames(SHI_Properties *self, SHI_Data **names)
Gets an array containing the names of all the properties in the list.
struct SHI_Properties SHI_Properties
A SHI_Properties object represents a list of name/value pairs.
Definition: ShiProperties.h:51
struct SHI_Data SHI_Data
A SHI_Data object represents a typed data object.
Definition: EmbProcessor.h:231
Common data types.
SHI_PUBLIC_API SHI_Cardinal SHI_Properties_GetPropertyCount(SHI_Properties *self)
Gets the number of properties in the list.
int SHI_Result
Signed integer value representing a function or method result (return value).
Definition: ShiTypes.h:74
Generic Data Objects.
SHI_PUBLIC_API SHI_Result SHI_Properties_SetProperty(SHI_Properties *self, const char *name, SHI_DataType type, const SHI_DataValue *value)
Sets the value of a property.