16.10 - Terminate Log Stream - Parallel Transporter

Teradata Parallel Transporter Operator Programmer Guide

prodname
Parallel Transporter
vrm_release
16.10
created_date
May 2017
category
Programming Reference
featnum
B035-2435-057K

Purpose

Terminate Log Stream is the service function that ends the log stream. Each initiated log stream (PX_LogInit) must be terminated with a call of PX_LogTerminate with its own specific log handle.

Structure

#include <pxoper.h>
PXSTC_Code PX_LogTerminate(PX_LogHandle  loghandle);

where the following is true:

Parameter Function Specification
loghandle input Handle to the log stream, freed by the Logger API.

Return Codes

The following Terminate Log Stream function status codes are defined by the Teradata PT operator interface:

Status Code Signifies
PXSTC_Success The call succeeded.
PXSTC_LogCommunicationError An error occurred from socket communication with the node Logger.
PXSTC_UnknownError Unknown termination error.

Usage Notes

Consider the following when defining the Terminate Log Stream function.

Topic Usage Notes
Status If the function status if PXSTC_Success, the message catalog for the operator was successfully terminated by this function. See also Initiate Log Stream.

Example - Terminate Log Stream

#include <pxoper.h>
PX_ErrorProc myerror;
PX_LogHandle loghandle;
PX_LogInit(oprhandle, "mycomponent", 75, NULL, myerror, &loghandle);
PX_LogTerminate(loghandle);