bstr_packet_notification_discard(3) — Subroutines

Name

bstr_packet_notification_discard − Frees all the resources associated with a received Packet notification (VODB only).

Syntax

bstr_t_status bstr_packet_notification_discard (
bstr_t_packet_notification ∗packet_notification);

Description

The bstr_packet_notification_discard procedure simplifies the release of the API resources associated with a received Packet notification. The following resources are discarded:

•The reference to the Packet object (the reference is specified by the packet_notification field)

•The sequence of the Packet output parameter values (the sequence address is specified by the data field).

This procedure does not free the memory allocated to the bstr_t_packet_notification data structure.

Arguments

packet_notification
access: read/write
The address of a bstr_t_packet_notification type data structure whose associated API resources must be discarded.

Return Values

BSTR_S_BAD_PARAMETER	Bad parameter value
BSTR_S_COM_PC_SIZE_MISMATCH	Number of bytes requested does not match with number of bytes returned
BSTR_S_NORMAL	Normal successful completion
BSTR_S_NOT_INITIALIZED	BASEstar Open not initialized