.TH "brlapi_misc" 3 "Thu Sep 07 2023" "Version 0.8" "BrlAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
brlapi_misc \- Miscellaneous functions
.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi_pause\fP (int timeout_ms)"
.br
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi__pause\fP (\fBbrlapi_handle_t\fP *handle, int timeout_ms)"
.br
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi_sync\fP (void)"
.br
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi__sync\fP (\fBbrlapi_handle_t\fP *handle)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "int \fBBRLAPI_STDCALL\fP brlapi__pause (\fBbrlapi_handle_t\fP * handle, int timeout_ms)"

.SS "int \fBBRLAPI_STDCALL\fP brlapi__sync (\fBbrlapi_handle_t\fP * handle)"

.SS "int \fBBRLAPI_STDCALL\fP brlapi_pause (int timeout_ms)"
Waits until an event is received from the BrlAPI server 
.PP
\fBParameters\fP
.RS 4
\fItimeout_ms\fP specifies an optional timeout which can be zero for polling, or -1 for infinite wait 
.RE
.PP
\fBReturns\fP
.RS 4
0 on timeout, -1 on error, or on interruption by a signal or a parameter change notification, in which case brlapi_errno will be BRLAPI_ERROR_LIBCERR and errno will be EINTR\&. 
.RE
.PP

.SS "int \fBBRLAPI_STDCALL\fP brlapi_sync (void)"
Synchronize against any pending exception, and returns it\&. This allows to synchronously catch exception raised by brlapi_write calls\&. This works by temporarily replacing the current exception handler by its own handler\&. 
.PP
\fBReturns\fP
.RS 4
0 if no exception was pending, -1 if an exception was caught\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for BrlAPI from the source code\&.