libgit2

git_note_read

Version:

Read the note for an object

The note must be freed manually by the user.

Signature

GitHub
int git_note_read(git_note **out, git_repository *repo, const char *notes_ref, const git_oid *oid);

Parameters

git_note **
In
out

pointer to the read note; NULL in case of error

git_repository *
In
repo

repository where to look up the note

const char *
In
notes_ref

canonical name of the reference to use (optional); defaults to "refs/notes/commits"

const git_oid *
In
oid

OID of the git object to read the note from

Returns

int

0 or an error code

Versions