SketchUp SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Functions
attribute_dictionary.h File Reference
#include <slapi/slapi.h>
#include <slapi/unicodestring.h>
#include <slapi/model/defs.h>
#include <slapi/model/typed_value.h>

Go to the source code of this file.

Functions

SU_RESULT SUAttributeDictionaryGetName (SUAttributeDictionaryRef dictionary, SUStringRef *name)
 Retrieves the name of an attribute dictionary object. More...
 
SU_RESULT SUAttributeDictionarySetValue (SUAttributeDictionaryRef dictionary, const char *key, SUTypedValueRef value_in)
 Inserts a key-value pair into an attribute dictionary object. More...
 
SU_RESULT SUAttributeDictionaryGetValue (SUAttributeDictionaryRef dictionary, const char *key, SUTypedValueRef *value_out)
 Retrieves the value associated with a given key from an attribute dictionary. More...
 
SU_RESULT SUAttributeDictionaryGetNumKeys (SUAttributeDictionaryRef dictionary, size_t *count)
 Retrieves the number of keys in an attribute dictionary object. More...
 
SU_RESULT SUAttributeDictionaryGetKeys (SUAttributeDictionaryRef dictionary, size_t len, SUStringRef keys[], size_t *count)
 Retrieves the array of keys of an attribute dictionary object. More...
 

Function Documentation

SU_RESULT SUAttributeDictionaryGetKeys ( SUAttributeDictionaryRef  dictionary,
size_t  len,
SUStringRef  keys[],
size_t *  count 
)

Retrieves the array of keys of an attribute dictionary object.

Parameters
[in]dictionaryThe attribute dictionary object.
[in]lenThe number of keys to retrieve.
[out]keysThe keys retrieved.
[out]countThe number of keys retrieved.
Returns
SU_RESULT SUAttributeDictionaryGetName ( SUAttributeDictionaryRef  dictionary,
SUStringRef name 
)

Retrieves the name of an attribute dictionary object.

Parameters
[in]dictionaryThe attribute dictionary object.
[out]nameThe name retrieved.
Returns
SU_RESULT SUAttributeDictionaryGetNumKeys ( SUAttributeDictionaryRef  dictionary,
size_t *  count 
)

Retrieves the number of keys in an attribute dictionary object.

Parameters
[in]dictionaryThe attribute dictionary object.
[out]countThe number of keys.
Returns
SU_RESULT SUAttributeDictionaryGetValue ( SUAttributeDictionaryRef  dictionary,
const char *  key,
SUTypedValueRef value_out 
)

Retrieves the value associated with a given key from an attribute dictionary.

Parameters
[in]dictionaryThe attribute dictionary object.
[in]keyThe key of the key-value pair. Assumed to be UTF-8 encoded.
[out]value_outThe value retrieved. Must be a valid object, i.e. must have been allocated via SUTypedValueCreate.
Returns
SU_RESULT SUAttributeDictionarySetValue ( SUAttributeDictionaryRef  dictionary,
const char *  key,
SUTypedValueRef  value_in 
)

Inserts a key-value pair into an attribute dictionary object.

Parameters
[in]dictionaryThe attribute dictionary object.
[in]keyThe key of the key-value pair. Assumed to be UTF-8 encoded.
[in]value_inThe value of the key-value pair.
Returns