SolarCapture C Bindings
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
attr.h
Go to the documentation of this file.
1 
8 #ifndef __SOLAR_CAPTURE_ATTR_H__
9 #define __SOLAR_CAPTURE_ATTR_H__
10 
11 
37 struct sc_attr;
38 
39 
49 extern int sc_attr_alloc(struct sc_attr** attr_out);
50 
56 extern void sc_attr_free(struct sc_attr* attr);
57 
63 extern void sc_attr_reset(struct sc_attr* attr);
64 
75 extern int sc_attr_set_int(struct sc_attr* attr,
76  const char* name, int64_t val);
77 
88 extern int sc_attr_set_str(struct sc_attr* attr,
89  const char* name, const char* s);
90 
101 extern int sc_attr_set_from_str(struct sc_attr* attr,
102  const char* name, const char* val);
103 
113 extern struct sc_attr* sc_attr_dup(const struct sc_attr* attr);
114 
115 
116 #if SC_API_VER >= 3
117 
123 extern int sc_attr_doc(const char* attr_name_opt,
124  const char*** docs_out, int* docs_len_out);
125 #endif
126 
127 
128 #endif /* __SOLAR_CAPTURE_ATTR_H__ */
129 
int sc_attr_set_str(struct sc_attr *attr, const char *name, const char *s)
Set an attribute to a string value.
int sc_attr_set_from_str(struct sc_attr *attr, const char *name, const char *val)
Set an attribute to a string value.
int sc_attr_doc(const char *attr_name_opt, const char ***docs_out, int *docs_len_out)
Returns documentation for attributes. Used by solar_capture_doc.
int sc_attr_set_int(struct sc_attr *attr, const char *name, int64_t val)
Set an attribute to an integer value.
Attribute object.
struct sc_attr * sc_attr_dup(const struct sc_attr *attr)
Duplicate an attribute object.
int sc_attr_alloc(struct sc_attr **attr_out)
Allocate an attribute object.
void sc_attr_free(struct sc_attr *attr)
Free an attribute object.
void sc_attr_reset(struct sc_attr *attr)
Return attributes to their default values.