Table of Contents Index NMS Glossary Previous Page Next Page (Page 8 of 11 in this chapter) Version


trauReleaseBuffer

Description

Returns an event buffer to the AG TRAU service buffer pool.

Prototype

DWORD trauReleaseBuffer ( CTAHD ctahd,
void
*buffer )

ctahd CTA context handle returned by ctaCreateContext.

buffer Address of the buffer being returned to the AG TRAU service. This must be a CTA_EVENT.buffer field received from ctaWaitEvent. The value of the buffer cannot be NULL.

Return Values

Events

None.

Details

This function frees retrieved event buffers returned by ctaWaitEvent.

Certain AG TRAU events return additional event data in a data structure attached to the CTA_EVENT. If a buffer is present, the CTA_EVENT.size field is set to the buffer size in bytes, and CTA_EVENT.buffer contains the address of the attached buffer. Otherwise, this value is NULL.

The returned ctahd is the handle contained in the event that contains the buffer (CTA_EVENT.ctahd).

Note: If the application does not release returned event buffers, return information is not sent when the buffer pool is exhausted. This causes events to be returned without expected buffers.

See Also

trauLoad



Table of Contents Index NMS Glossary Previous Page Next Page (Page 8 of 11 in this chapter) Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.