Modulemd.Profile: Modulemd Reference Manual

Modulemd.Profile

Modulemd.Profile — Stores profile information for a module stream.

Functions

ModulemdProfile *	modulemd_profile_new ()
void	modulemd_profile_set_description ()
const gchar *	modulemd_profile_get_description ()
gchar *	modulemd_profile_get_localized_description ()
const gchar *	modulemd_profile_peek_description ()
gchar *	modulemd_profile_dup_description ()
void	modulemd_profile_set_name ()
const gchar *	modulemd_profile_get_name ()
const gchar *	modulemd_profile_peek_name ()
gchar *	modulemd_profile_dup_name ()
void	modulemd_profile_set_rpms ()
ModulemdSimpleSet *	modulemd_profile_get_rpms ()
ModulemdSimpleSet *	modulemd_profile_peek_rpms ()
ModulemdSimpleSet *	modulemd_profile_dup_rpms ()
void	modulemd_profile_add_rpm ()
void	modulemd_profile_remove_rpm ()
ModulemdProfile *	modulemd_profile_copy ()

Types and Values

#define	MODULEMD_TYPE_PROFILE
	ModulemdProfile

Description

Functions

modulemd_profile_new ()

ModulemdProfile *
modulemd_profile_new (void);

Returns

A newly-allocated ModulemdProfile. This object must be freed with g_object_unref().

[transfer full]

Since: 1.0

modulemd_profile_set_description ()

void
modulemd_profile_set_description (ModulemdProfile *self,
                                  const gchar *description);

Sets the "description" property.

Parameters

description

the profile description.

[nullable]

Since: 1.0

modulemd_profile_get_description ()

const gchar *
modulemd_profile_get_description (ModulemdProfile *self);

modulemd_profile_get_description has been deprecated since version 1.1 and should not be used in newly-written code.

Use peek_description() instead.

Retrieves the profile description.

Returns

A string containing the "description" property.

Since: 1.0

modulemd_profile_get_localized_description ()

gchar *
modulemd_profile_get_localized_description
                               (ModulemdProfile *self,
                                const gchar *locale);

Parameters

locale

Specify the locale for the description. If NULL is passed, it will attempt to use the LC_MESSAGES locale. If "C" is passed or if the locale has no translation available, it will treat it as untranslated.

[transfer none][nullable]

Returns

A string containing the "description" property, translated into the language specified by locale if possible. This string must be freed with g_free().

[transfer full]

Since: 1.6

modulemd_profile_peek_description ()

const gchar *
modulemd_profile_peek_description (ModulemdProfile *self);

Retrieves the profile description.

Returns

A string containing the "description" property.

Since: 1.1

modulemd_profile_dup_description ()

gchar *
modulemd_profile_dup_description (ModulemdProfile *self);

Retrieves a copy of the profile description.

Returns

A copy of the string containing the "description" property.

Since: 1.1

modulemd_profile_set_name ()

void
modulemd_profile_set_name (ModulemdProfile *self,
                           const gchar *name);

Sets the "name" property.

Parameters

name

the profile name.

[nullable]

Since: 1.0

modulemd_profile_get_name ()

const gchar *
modulemd_profile_get_name (ModulemdProfile *self);

modulemd_profile_get_name has been deprecated since version 1.1 and should not be used in newly-written code.

Use peek_name() instead.

Retrieves the profile name.

Returns

A string containing the "name" property.

Since: 1.0

modulemd_profile_peek_name ()

const gchar *
modulemd_profile_peek_name (ModulemdProfile *self);

Retrieves the profile name.

Returns

A string containing the "name" property.

Since: 1.1

modulemd_profile_dup_name ()

gchar *
modulemd_profile_dup_name (ModulemdProfile *self);

Retrieves a copy of the profile name.

Returns

A copy of string containing the "name" property.

Since: 1.1

modulemd_profile_set_rpms ()

void
modulemd_profile_set_rpms (ModulemdProfile *self,
                           ModulemdSimpleSet *rpms);

Assigns the set of RPMs that will be installed when this profile is activated.

Parameters

rpms

A ModuleSimpleSet: The rpms to be installed by this profile.

[nullable]

Since: 1.0

modulemd_profile_get_rpms ()

ModulemdSimpleSet *
modulemd_profile_get_rpms (ModulemdProfile *self);

modulemd_profile_get_rpms has been deprecated since version 1.1 and should not be used in newly-written code.

Use peek_rpms() instead.

Retrieves the "rpms" for this profile

Returns

a SimpleSet containing the set of RPMs in the "rpms" property.

[transfer none]

Since: 1.0

modulemd_profile_peek_rpms ()

ModulemdSimpleSet *
modulemd_profile_peek_rpms (ModulemdProfile *self);

Retrieves the "rpms" for this profile

Returns

a SimpleSet containing the set of RPMs in the "rpms" property.

[transfer none]

Since: 1.1

modulemd_profile_dup_rpms ()

ModulemdSimpleSet *
modulemd_profile_dup_rpms (ModulemdProfile *self);

Retrieves a copy of the "rpms" for this profile

Returns

a SimpleSet containing the set of RPMs in the "rpms" property.

[transfer full]

Since: 1.1

modulemd_profile_add_rpm ()

void
modulemd_profile_add_rpm (ModulemdProfile *self,
                          const gchar *rpm);

Parameters

rpm

An RPM that will be installed as part of this profile.

[transfer none][not nullable]

Since: 1.1

modulemd_profile_remove_rpm ()

void
modulemd_profile_remove_rpm (ModulemdProfile *self,
                             const gchar *rpm);

Parameters

rpm

An RPM that will no longer be installed as part of this profile.

[transfer none][not nullable]

Since: 1.1

modulemd_profile_copy ()

ModulemdProfile *
modulemd_profile_copy (ModulemdProfile *self);

Creates a copy of this profile

Returns

a copy of this ModulemdProfile.

[transfer full]

Since: 1.1

Types and Values

MODULEMD_TYPE_PROFILE

#define MODULEMD_TYPE_PROFILE modulemd_profile_get_type ()

ModulemdProfile

typedef struct _ModulemdProfile ModulemdProfile;