GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  EXPLAIN_TCSENDBREAK_OR_DIE (3)

NAME

explain_tcsendbreak_or_die - send terminal line break and report errors
"send terminal line break and report errors"

CONTENTS

Synopsis
Description
Return Value
Example
See Also
Copyright

SYNOPSIS

#include <libexplain/tcsendbreak.h>

void explain_tcsendbreak_or_die(int fildes, int duration);
int explain_tcsendbreak_on_error(int fildes, int duration);

DESCRIPTION

The B]explain_tcsendbreak_or_die function is used to call the I]tcsendbreak(3) system call. On failure an explanation will be printed to I]stderr, obtained from the I]explain_tcsendbreak(3) function, and then the process terminates by calling CW]exit(EXIT_FAILURE).

The B]explain_tcsendbreak_on_error function is used to call the I]tcsendbreak(3) system call. On failure an explanation will be printed to I]stderr, obtained from the I]explain_tcsendbreak(3) function, but still returns to the caller.
I]fildes The fildes, exactly as to be passed to the I]tcsendbreak(3) system call.
I]duration
  The duration, exactly as to be passed to the I]tcsendbreak(3) system call.

RETURN VALUE

The B]explain_tcsendbreak_or_die function only returns on success, see I]tcsendbreak(3) for more information. On failure, prints an explanation and exits, it does not return.

The B]explain_tcsendbreak_on_error function always returns the value return by the wrapped I]tcsendbreak(3) system call.

EXAMPLE

The B]explain_tcsendbreak_or_die function is intended to be used in a fashion similar to the following example:
explain_tcsendbreak_or_die(fildes, duration);

SEE ALSO

I]tcsendbreak(3)
  send terminal line break
I]explain_tcsendbreak(3)
  explain I]tcsendbreak(3) errors
I]exit(2) terminate the calling process

COPYRIGHT

libexplain version 1.3
Copyright © 2009 Peter Miller
Search for    or go to Top of page |  Section 3 |  Main Index


EXPLAIN_TCSENDBREAK_OR_DIE (3) -->

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.