xenocara/lib/libXv/man/XvSelectPortNotify.man

50 lines
1.4 KiB
Groff
Raw Normal View History

2009-10-31 12:54:56 -06:00
.TH XvSelectPortNotify __libmansuffix__ __vendorversion__ "libXv Functions"
.SH NAME
XvSelectPortNotify \- enable or disable XvPortNotify events
2006-11-25 11:01:46 -07:00
.\"
2009-10-31 12:54:56 -06:00
.SH SYNOPSIS
2006-11-25 11:01:46 -07:00
.B #include <X11/extensions/Xvlib.h>
2008-05-24 07:46:47 -06:00
.sp
.nf
2009-10-31 12:54:56 -06:00
.BI "int XvSelectPortNotify(Display *" dpy ", XvPortID " port ", Bool " onoff ");"
2008-05-24 07:46:47 -06:00
.fi
2009-10-31 12:54:56 -06:00
.SH ARGUMENTS
2006-11-25 11:01:46 -07:00
.\"
.IP \fIdpy\fR 8
Specifies the connection to the X server.
.IP \fIport\fR 8
Specifies the port for which PortNotify events are to be generated
2009-10-31 12:54:56 -06:00
when its attributes are changed using
.BR XvSetPortAttribute (__libmansuffix__)
.
2006-11-25 11:01:46 -07:00
.IP \fIonoff\fR 8
Specifies whether notification is to be enabled or disabled.
.\"
2009-10-31 12:54:56 -06:00
.SH DESCRIPTION
2006-11-25 11:01:46 -07:00
.\"
2009-10-31 12:54:56 -06:00
.BR XvSelectPortNotify (__libmansuffix__)
enables or disables PortNotify event delivery to the requesting client.
.BR XvPortNotify (__libmansuffix__)
events are generated when port attributes are changed using
.BR XvSetPortAttribute (__libmansuffix__).
2006-11-25 11:01:46 -07:00
.\"
2009-10-31 12:54:56 -06:00
.SH RETURN VALUES
2006-11-25 11:01:46 -07:00
.IP [Success] 8
2009-10-31 12:54:56 -06:00
Returned if
.BR XvSelectPortNotify (__libmansuffix__)
completed successfully.
2006-11-25 11:01:46 -07:00
.IP [XvBadExtension] 8
Returned if the Xv extension is unavailable.
.IP [XvBadAlloc] 8
2009-10-31 12:54:56 -06:00
Returned if
.BR XvSelectPortNotify (__libmansuffix__)
failed to allocate memory to process the request.
.SH DIAGNOSTICS
2006-11-25 11:01:46 -07:00
.IP [XvBadPort] 8
Generated if the requested port does not exist.
2009-10-31 12:54:56 -06:00
.SH SEE ALSO
2006-11-25 11:01:46 -07:00
.\"
2009-10-31 12:54:56 -06:00
.BR XvSetPortNotify (__libmansuffix__),
.BR XvSetPortAttribute (__libmansuffix__),
.BR XvPortNotify (__libmansuffix__)