luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-01 13:23:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

[doc] Document GIErrorDomainInfo methods

Browse Source
This commit is contained in:
Johan Dahlin 2010-05-28 20:49:39 -03:00
parent c2b89be46e
commit 3bab700cd4
1 changed files with 44 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
ginfo.c
View File

@ -1644,7 +1644,7 @@ g_type_info_get_n_error_domains (GITypeInfo *info)
* must be a #GI_TYPE_TAG_ERROR or -1 will be returned. * must be a #GI_TYPE_TAG_ERROR or -1 will be returned.
* *
* Returns: (transfer full): the error domain or %NULL if type tag is wrong, * Returns: (transfer full): the error domain or %NULL if type tag is wrong,
* free the struct withg_base_info_unref() when done. * free the struct with g_base_info_unref() when done.
*/ */
GIErrorDomainInfo * GIErrorDomainInfo *
g_type_info_get_error_domain (GITypeInfo *info, g_type_info_get_error_domain (GITypeInfo *info,
@ -1673,20 +1673,61 @@ g_type_info_get_error_domain (GITypeInfo *info,
/* GIErrorDomainInfo functions */ /* GIErrorDomainInfo functions */
/**
* SECTION:gierrordomaininfo
* @Short_description: Struct representing an error domain
* @Title: GIErrorDomainInfo
*
* A GIErrorDomainInfo struct represents a domain of a #GError.
* An error domain is associated with a #GQuark and contains a pointer
* to an enum with all the error codes.
*/
/**
* g_error_domain_info_get_quark:
* @info: a #GIErrorDomainInfo
*
* Obtain a string representing the quark for this error domain.
* %NULL will be returned if the type tag is wrong or if a quark is
* missing in the typelib.
*
* Returns: the quark represented as a string or %NULL
*/
const gchar * const gchar *
g_error_domain_info_get_quark (GIErrorDomainInfo *info) g_error_domain_info_get_quark (GIErrorDomainInfo *info)
{ {
GIRealInfo *rinfo = (GIRealInfo *)info; GIRealInfo *rinfo = (GIRealInfo *)info;
ErrorDomainBlob *blob = (ErrorDomainBlob *)&rinfo->typelib->data[rinfo->offset]; ErrorDomainBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_ERROR_DOMAIN_INFO (info), NULL);
blob = (ErrorDomainBlob *)&rinfo->typelib->data[rinfo->offset];
return g_typelib_get_string (rinfo->typelib, blob->get_quark); return g_typelib_get_string (rinfo->typelib, blob->get_quark);
} }
/**
* g_error_domain_info_get_codes:
* @info: a #GIErrorDomainInfo
*
* Obtain the enum containing all the error codes for this error domain.
* The return value will have a #GIInfoType of %GI_INFO_TYPE_ERROR_DOMAIN
*
* Returns: (transfer full): the error domain or %NULL if type tag is wrong,
* free the struct with g_base_info_unref() when done.
*/
GIInterfaceInfo * GIInterfaceInfo *
g_error_domain_info_get_codes (GIErrorDomainInfo *info) g_error_domain_info_get_codes (GIErrorDomainInfo *info)
{ {
GIRealInfo *rinfo = (GIRealInfo *)info; GIRealInfo *rinfo = (GIRealInfo *)info;
ErrorDomainBlob *blob = (ErrorDomainBlob *)&rinfo->typelib->data[rinfo->offset]; ErrorDomainBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_ERROR_DOMAIN_INFO (info), NULL);
blob = (ErrorDomainBlob *)&rinfo->typelib->data[rinfo->offset];
return (GIInterfaceInfo *) g_info_from_entry (rinfo->repository, return (GIInterfaceInfo *) g_info_from_entry (rinfo->repository,
rinfo->typelib, blob->error_codes); rinfo->typelib, blob->error_codes);