Method

GgitRepositoryread_note

Declaration [src] 

GgitNote*
ggit_repository_read_note (
  GgitRepository* repository,
  const gchar* notes_ref,
  GgitOId* id,
  GError** error
)

Description [src]

Reads the note for an object.

Parameters

notes_ref const gchar*
 

Canonical name of the reference to use, or NULL to use the default ref.
 The argument can be NULL.
 The data is owned by the caller of the function.
 The value is a NUL terminated UTF-8 string.
id GgitOId
 

OID of the git object to decorate.
 The data is owned by the caller of the function.
error GError **
  The return location for a GError*, or NULL.

Return value

Returns: GgitNote
 

The read note or NULL in case of an error.
 The caller of the method takes ownership of the data, and is responsible for freeing it.
 The return value can be NULL.