seq_open (9) - Linux Manuals

seq_open: initialize sequential file

Command to display seq_open manual in Linux: $ man 9 seq_open

NAME

seq_open - initialize sequential file

SYNOPSIS

int seq_open(struct file * file, const struct seq_operations * op);

ARGUMENTS

file

: file we initialize

: method table describing the sequence

DESCRIPTION

seq_open sets file, associating it with a sequence described by op. op->start sets the iterator up and returns the first element of sequence. op->stop shuts it down. op->next returns the next element of sequence. op->show prints element into the buffer. In case of error ->start and ->next return ERR_PTR(error). In the end of sequence they return NULL. ->show returns 0 in case of success and negative number in case of error. Returning SEQ_SKIP means "discard this element and move on".

NOTE

seq_open will allocate a struct seq_file and store its pointer in file->private_data. This pointer should not be modified.