![]() |
mode flags for vpb_open() | |
const VPBOpenMode | VPB_OPEN_NONE = 0x00 |
Just open the port. | |
const VPBOpenMode | VPB_OPEN_RESET = 0x10 |
Reset the port state. | |
const VPBOpenMode | VPB_OPEN_DEFAULTS = VPB_OPEN_RESET |
The default flags for vpb_open() . | |
Typedefs | |
typedef int | VPBOpenMode |
Symbolic type for vpb_open() mode flags. | |
Functions | |
VPBPortHandle WINAPI | vpb_open (unsigned int board, unsigned int port, VPBOpenMode flags=VPB_OPEN_DEFAULTS) |
Open a port on some board for use. | |
void WINAPI | vpb_reset (VPBPortHandle handle=VPB_PORTHANDLE_NULL) |
Reset a port back to its idle state (on-hook, not ringing etc.). | |
int WINAPI | vpb_close (VPBPortHandle handle=VPB_PORTHANDLE_NULL) |
Close a previously opened port using the handle returned by vpb_open() . |
int WINAPI vpb_close | ( | VPBPortHandle | handle = VPB_PORTHANDLE_NULL |
) |
Close a previously opened port using the handle returned by vpb_open()
.
handle | The handle returned by a call to vpb_open() . If not specified, this will close all currently open ports. |
VPB_OK
if all goes well. various | exceptions may be thrown in the event of an error. |
VPBPortHandle WINAPI vpb_open | ( | unsigned int | board, | |
unsigned int | port, | |||
VPBOpenMode | flags = VPB_OPEN_DEFAULTS | |||
) |
Open a port on some board for use.
board | The board number, starting from 0. | |
port | The port number on board, starting from 0. | |
flags | The VPBOpenMode flags which indicate additional operations to perform when opening the port. |
void WINAPI vpb_reset | ( | VPBPortHandle | handle = VPB_PORTHANDLE_NULL |
) |
Reset a port back to its idle state (on-hook, not ringing etc.).
handle | The handle returned by a call to vpb_open() . If not specified, then all open ports will be reset. |
Any hardware gains will be restored to their default levels, or to the levels specified if configuration files are present.
The locale specific hardware configuration will be reset according to (in order of priority):
vpb_set_country()
.country
value specified in the configuration files.VPB_COUNTRY
environment variable.AUSTRALIA
).