VCI - Virtual CAN Interface - Ixxat

Interface description4.3.2.10 canChannelWaitTxEventThe function waits until the transmit event has occurred, or a certain waiting timehas elapsed. The complete syntax of the function is:HRESULT canChannelWaitTxEvent (HANDLE hChannelUINT32 dwMsTimeout );Parameters:hChannel[in] Handle of the opened message channel.dwMsTimeoutMaximum waiting time in milliseconds. The function returns to the callerwith the error code VCI_E_TIMEOUT if the transmit event has not occurredwithin the time specified here. With the value INFINITE (0xFFFFFFFF), thefunction waits until the transmit event has occured.Return value:If run successfully, the function returns the value VCI_OK. If the time periodspecified in the parameter dwMsTimeout has elapsed without the transmitevent having occured, the function returns the error code VCI_E_TIMEOUT. Inthe event of an error, the function returns an error code not equal to VCI_OKor VCI_E_TIMEOUT. Further information on the error code is provided by thefunction vciFormatError.Comments:The transmit event is triggered as soon as the transmit buffer contains thesame number of free entries as the set threshold or more. See the descriptionof the function canChannelInitialize.To check whether the transmit event has already occurred without blockingthe calling program, the value 0 can be specified in the parameter dwMsTimeoutwhen the function is called.If the handle specified in hChannel is closed from another thread, the functionends the current function control and returns with a return value not equal toVCI_OK.67Copyright IXXAT Automation GmbH C-API Programming Manual, Version 1.5