OpenTP1 Version 7 TP1/Client User's Guide TP1/Client/W, TP1/Client/P

[Contents][Index][Back][Next]

4.8.2 tpfree - Release typed buffer

Organization of this subsection
(1) Form
(2) Purpose
(3) Argument set by UAPs
(4) Notes

(1) Form

(a) TP1/Client/W
 
#include <dcvxatmi.h>
void tpfree(char *ptr)
 
(b) TP1/Client/P
 
#include <dcvxatmi.h>
void tpfree(char CLTFAR *ptr)
 

(2) Purpose

Releases the typed buffer allocated by tpalloc.

The tpfree function does not return the return value to the caller. The function must be specified in the void type.

The typed buffer is not released when NULL is specified in the argument ptr. Processing results of the tpfree function are not guaranteed when the value specified in ptr is not the pointer to the typed buffer or has already been released by the tpfree function.

For the buffer type used for requesting information or when it is linked to data, releasing the buffer also deletes its additional information. The tpfree function deletes the linkage of additional information before releasing the buffer. Define the method of deletion of additional information by communication resource managers for TP1/Client and TP1/Server Base.

Once the tpfree function returns, the argument specified in ptr can no longer be passed to an XATMI interface function as a new argument or be referenced.

(3) Argument set by UAPs

(4) Notes