Update documentation for to have correct headers
[platform/upstream/libsecret.git] / libsecret / secret-value.h
1 /* libsecret - GLib wrapper for Secret Service
2  *
3  * Copyright 2011 Collabora Ltd.
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License as published
7  * by the Free Software Foundation; either version 2.1 of the licence or (at
8  * your option) any later version.
9  *
10  * See the included COPYING file for more information.
11  *
12  * Author: Stef Walter <stefw@gnome.org>
13  */
14
15 #if !defined (__SECRET_INSIDE_HEADER__) && !defined (SECRET_COMPILATION)
16 #error "Only <libsecret/secret.h> can be included directly."
17 #endif
18
19 #ifndef __SECRET_VALUE_H__
20 #define __SECRET_VALUE_H__
21
22 #include <gio/gio.h>
23
24 #include "secret-types.h"
25
26 G_BEGIN_DECLS
27
28 typedef struct _SecretValue  SecretValue;
29
30 #define             SECRET_TYPE_VALUE              (secret_value_get_type ())
31
32 GType               secret_value_get_type          (void) G_GNUC_CONST;
33
34 SecretValue *       secret_value_new               (const gchar *secret,
35                                                     gssize length,
36                                                     const gchar *content_type);
37
38 SecretValue *       secret_value_new_full          (gchar *secret,
39                                                     gssize length,
40                                                     const gchar *content_type,
41                                                     GDestroyNotify destroy);
42
43 const gchar *       secret_value_get               (SecretValue *value,
44                                                     gsize *length);
45
46 const gchar *       secret_value_get_content_type  (SecretValue *value);
47
48 SecretValue *       secret_value_ref               (SecretValue *value);
49
50 void                secret_value_unref             (gpointer value);
51
52 G_END_DECLS
53
54 #endif /* __SECRET_VALUE_H___ */