Next: PO Header Entry API, Previous: po_message_iterator_t API, Up: libgettextpo [Contents][Index]
msgid
and msgstr
. It must be inserted into a file to manage its memory, as there is no po_message_free
available to the user of the library.The following functions access details of a po_message_t
. Recall
that the results are valid as long as the file
handle is valid.
message
)po_message_msgctxt
function returns the msgctxt
, the context of message
. Returns NULL
for a message not restricted to a context.message
, const char *msgctxt
)po_message_set_msgctxt
function changes the msgctxt
, the context of the message, to the value provided through msgctxt
. The value NULL
removes the restriction.message
)po_message_msgid
function returns the msgid
(untranslated English string) of message
. This is guaranteed to be non-NULL
.message
, const char *msgid
)po_message_set_msgid
function changes the msgid
(untranslated English string) of message
to the value provided through msgid
, a non-NULL
string.message
)po_message_msgid_plural
function returns the msgid_plural
(untranslated English plural string) of message
, a message with plurals, or NULL
for a message without plural.message
, const char *msgid_plural
)po_message_set_msgid_plural
function changes the msgid_plural
(untranslated English plural string) of a message to the value provided through msgid_plural
, or removes the plurals if NULL
is provided as msgid_plural
.message
)po_message_msgstr
function returns the msgstr
(translation) of message
. For an untranslated message, the return value is an empty string.message
, const char *msgstr
)po_message_set_msgstr
function changes the msgstr
(translation) of message
to the value provided through msgstr
, a non-NULL
string.message
, int index
)po_message_msgstr_plural
function returns the msgstr[index]
of message
, a message with plurals, or NULL
when the index
is out of range or for a message without plural.message
, int index
, const char *msgstr_plural
)po_message_set_msgstr_plural
function changes the msgstr[index]
of message
, a message with plurals, to the value provided through msgstr_plural
. message
must be a message with plurals. Use NULL
as the value of msgstr_plural
with index
pointing to the last element to reduce the number of plural forms.message
)po_message_comments
function returns the comments of message
, a multiline string, ending in a newline, or a non-NULL
empty string.message
, const char *comments
)po_message_set_comments
function changes the comments of message
to the value comments
, a multiline string, ending in a newline, or a non-NULL
empty string.message
)po_message_extracted_comments
function returns the extracted comments of message
, a multiline string, ending in a newline, or a non-NULL
empty string.message
, const char *extracted_comments
)po_message_set_extracted_comments
function changes the comments of message
to the value extracted_comments
, a multiline string, ending in a newline, or a non-NULL
empty string.message
)po_message_prev_msgctxt
function returns the previous msgctxt
, the previous context of message
. Return NULL
for a message that does not have a previous context.message
, const char *prev_msgctxt
)po_message_set_prev_msgctxt
function changes the previous msgctxt
, the context of the message, to the value provided through prev_msgctxt
. The value NULL
removes the stored previous msgctxt.message
)po_message_prev_msgid
function returns the previous msgid
(untranslated English string) of message
, or NULL
if there is no previous msgid
stored.message
, const char *prev_msgid
)po_message_set_prev_msgid
function changes the previous msgid
(untranslated English string) of message
to the value provided through prev_msgid
, or removes the message when it is NULL
.message
)po_message_prev_msgid_plural
function returns the previous msgid_plural
(untranslated English plural string) of message
, a message with plurals, or NULL
for a message without plural without any stored previous msgid_plural
.message
, const char *prev_msgid_plural
)po_message_set_prev_msgid_plural
function changes the previous msgid_plural
(untranslated English plural string) of a message to the value provided through prev_msgid_plural
, or removes the stored previous msgid_plural
if NULL
is provided as prev_msgid_plural
.message
)po_message_is_obsolete
function returns true when message
is marked as obsolete.message
, int obsolete
)po_message_set_obsolete
function changes the obsolete mark of message
.message
)po_message_is_fuzzy
function returns true when message
is marked as fuzzy.message
, int fuzzy
)po_message_set_fuzzy
function changes the fuzzy mark of message
.message
, const char *format_type
)po_message_is_format
function returns true when the message is marked as being a format string of format_type
.message
, const char *format_type
, int value
)po_message_set_fuzzy
function changes the format mark of the message for the format_type
provided.message
, int *minp
, int *maxp
)po_message_is_range
function returns true when the message has a numeric range set, and stores the minimum and maximum value in the locations pointed by minp
and maxp
respectively.message
, int min
, int max
)po_message_set_range
function changes the numeric range of the message. min
and max
must be non-negative, with min
< max
. Use min
and max
with value -1
to remove the numeric range of message
.Next: PO Header Entry API, Previous: po_message_iterator_t API, Up: libgettextpo [Contents][Index]