polkit-policy-file-entry

polkit-policy-file-entry — Policy files entries.

Synopsis




struct              PolKitPolicyFileEntry;
PolKitPolicyFileEntry* polkit_policy_file_entry_ref     (PolKitPolicyFileEntry *policy_file_entry);
void                polkit_policy_file_entry_unref      (PolKitPolicyFileEntry *policy_file_entry);
void                polkit_policy_file_entry_debug      (PolKitPolicyFileEntry *policy_file_entry);
const char*         polkit_policy_file_entry_get_id     (PolKitPolicyFileEntry *policy_file_entry);
const char*         polkit_policy_file_entry_get_group_id
                                                        (PolKitPolicyFileEntry *policy_file_entry);
PolKitPolicyDefault* polkit_policy_file_entry_get_default
                                                        (PolKitPolicyFileEntry *policy_file_entry);
const char*         polkit_policy_file_get_group_description
                                                        (PolKitPolicyFileEntry *policy_file_entry);
const char*         polkit_policy_file_get_action_description
                                                        (PolKitPolicyFileEntry *policy_file_entry);

Description

This class is used to represent a entries in policy files.

Details

struct PolKitPolicyFileEntry

struct PolKitPolicyFileEntry;

Objects of this class are used to record information about a policy.


polkit_policy_file_entry_ref ()

PolKitPolicyFileEntry* polkit_policy_file_entry_ref     (PolKitPolicyFileEntry *policy_file_entry);

Increase reference count.

policy_file_entry : the policy file object
Returns : the object

polkit_policy_file_entry_unref ()

void                polkit_policy_file_entry_unref      (PolKitPolicyFileEntry *policy_file_entry);

Decreases the reference count of the object. If it becomes zero, the object is freed. Before freeing, reference counts on embedded objects are decresed by one.

policy_file_entry : the policy file object

polkit_policy_file_entry_debug ()

void                polkit_policy_file_entry_debug      (PolKitPolicyFileEntry *policy_file_entry);

Print debug information about object

policy_file_entry : the entry

polkit_policy_file_entry_get_id ()

const char*         polkit_policy_file_entry_get_id     (PolKitPolicyFileEntry *policy_file_entry);

Get the action identifier.

policy_file_entry : the file entry
Returns : A string - caller shall not free this string.

polkit_policy_file_entry_get_group_id ()

const char*         polkit_policy_file_entry_get_group_id
                                                        (PolKitPolicyFileEntry *policy_file_entry);

Get the action group identifier.

policy_file_entry : the file entry
Returns : A string - caller shall not free this string.

polkit_policy_file_entry_get_default ()

PolKitPolicyDefault* polkit_policy_file_entry_get_default
                                                        (PolKitPolicyFileEntry *policy_file_entry);

Get the the default policy for this policy.

policy_file_entry : the file entry
Returns : A PolKitPolicyDefault object - caller shall not unref this object.

polkit_policy_file_get_group_description ()

const char*         polkit_policy_file_get_group_description
                                                        (PolKitPolicyFileEntry *policy_file_entry);

Get the description of the group that this policy entry describes.

Note, if polkit_context_set_load_descriptions() on the PolKitContext object used to get this object wasn't called, this method will return NULL.

policy_file_entry : the object
Returns : string or NULL if descriptions are not loaded - caller shall not free this string

polkit_policy_file_get_action_description ()

const char*         polkit_policy_file_get_action_description
                                                        (PolKitPolicyFileEntry *policy_file_entry);

Get the description of the action that this policy entry describes.

Note, if polkit_context_set_load_descriptions() on the PolKitContext object used to get this object wasn't called, this method will return NULL.

policy_file_entry : the object
Returns : string or NULL if descriptions are not loaded - caller shall not free this string