beautypg.com

7 deletetransmitpipe, Method, 8 savereceivepipefile – Teledyne LeCroy Automation API for Bluetooth Exercisers User Manual

Page 11: 9 closereceivepipe, 7 deletetransmitpipe method, 8 savereceivepipefile method, 9 closereceivepipe method

background image

CATC

Automation API for CATC Bluetooth Exercisers

Manual Version 1.01

8

2.2.7 DeleteTransmitPipe Method

HRESULT DeleteTransmitPipe( BSTR pipe_name )


Removes a transmit pipe to the data transfer manager. Returns failure if the transmit pipe
does not exist.

BSTR pipe_name [in]:

Name of the pipe to remove.

Errors:

BTEXERCISER_ERROR_PIPE_NOT_FOUND:

No transmit pipe with this name can be found.

BTEXERCISER_ERROR_BUSY:

The application status not ready.

Requirements:
BTTrainer 2.01

2.2.8 SaveReceivePipeFile Method

HRESULT SaveReceivePipeFile( BSTR pipe_name, BSTR file_name )


Saves the data associated with a receive pipe to a file. Returns failure if the receive pipe
does not exist, or there were errors saving the file.

BSTR pipe_name [in]:

Name of the receive pipe.

BSTR file_name [in]:

Filename of server side file to use.

Errors:

BTEXERCISER_ERROR_PIPE_NOT_FOUND:

No receive pipe with this name can be found.

BTEXERCISER_ERROR_FILE:

There was a problem writing the file. The error string will contain a description of the
error.

BTEXERCISER_ERROR_BUSY:

The application status not ready.

Requirements:
BTTrainer 2.01

2.2.9 CloseReceivePipe Method

HRESULT CloseReceivePipe ( BSTR pipe_name )


Closes a receive pipe. Returns failure if the receive pipe does not exist.