Tap Write Buffer

DLM Tap

Tap Write Buffer

dlm_TapWriteBuffer()

Writes a single buffer of data to the tap server.

Syntax

#include "dlmtap.h"

DlmResult dlm_TapWriteBuffer
    (
        DlmLine    line,
        Buffer     buffer,
        DlmSource  source
    );

line	id of session to write to
buffer	buffer to write
source	source of the buffer

Description

dlm_TapWriteBuffer() writes a single buffer of data to the tap server.

Return Values

If successful, dlm_TapWriteBuffer() returns a non-negative value. Otherwise, it returns a negative value indicating the reason it failed. Possible unsuccessful return values are:

dlm_ERROR_CONNECTION_FAILURE
dlm_ERROR_CONNECTION_INCOMPLETE
dlm_ERROR_INVALID_COMMAND
dlm_ERROR_INVALID_LINE_ID
dlm_ERROR_INVALID_PARAMETERS

Example

if ((result = dlm_TapWriteBuffer(dlm_Line, &buffer, source)) < 0)
{
    printf("Error: Failure writing buffer - %s (%d).\n",
                              dlm_ErrorMessage(result), result);
}
else
{
    /* do something */
}