Name

xosd_get_number_lines — Get the number of lines able to be shown by the XOSD window

Synopsis

#include <xosd.h>

int xosd_get_colour(xosd *osd);

Description

xosd_get_number_lines returns the maximum number of lines allowed in an XOSD window. The lines argument to xosd_display(3xosd) cannot be greater than the return value of xosd_get_number_lines.

Arguments

osd

The XOSD window to query.

Return Value

On success the maximum number of lines allowed in the XOSD window is returned. On error -1 is returned and xosd_error is set to indicate the reason for the error.

Environment

char *xosd_error

A string describing the error, if one occurred.

Authors

The XOSD library was originally written by André Renaud, and is currently maintained by Tim Wright. This document was written by Michael JasonSmith.

Bugs

There are no known bugs with xosd_get_number_lines. Bug reports can be sent to .

See Also

xosd_create(3xosd), xosd_display(3xosd)