7. Function specifications-6

7.6 Transfer information acquisition

List

Title Function specifications

Function Acquisition of the number of data in the transfer area

Function Name STM_GetLenTrBuf

No 6.1

Form

Sint32 STM_GetLenTrBuf (StmHn stm)

input

stm: stream handle

output

none

Function value

Number of data (word unit)

function

Gets the number of data (words) in the transfer area.

List

Title Function specifications

Function Full transfer area check

Function Name STM_IsTrBufFull

No 6.2.

Form

Bool STM_IsTrBufFull (StmHn stm)

input

stm: stream handle

output

none

Function value

TRUE	: When the size of the transfer area is reached
FALSE	: When the size of the transfer area has not been reached

function

Checks if the number of data in the transfer area has reached the size of the area.

remarks

The transfer area can be reset by STM_ResetTrBuf.

List

Title Function specifications

Function Check during transfer

Function Name STM_IsTrans

No 6.3

Form

Bool STM_IsTrans (StmHn stm)

input

stm: stream handle

output

none

Function value

TRUE	: When transferring
FALSE	: If not in transit

function

Check if the transfer is in progress.