IXDSCodec::GetXDSPacket Method

Article
2009-01-07

This topic applies to Windows XP Service Pack 1 or later.
The GetXDSPacket method retrieves the most recent XDS packet.

Syntax

HRESULT GetXDSPacket(
  [out]  long *pXDSClassPkt,
  [out]  long *pXDSTypePkt,
  [out]  BSTR *pBstrXDSPkt,
  [out]  long *pPktSeqID,
  [out]  long *pCallSeqID,
  [out]  REFERENCE_TIME *pTimeStart,
  [out]  REFERENCE_TIME *pTimeEnd
);

Parameters

pXDSClassPkt [out]
Receives the packet class.
pXDSTypePkt [out]
Receives the class-specific packet type.
pBstrXDSPkt [out]
Receives the packet as a BSTR value.
pPktSeqID [out]
Receives the number of ratings packets that have been decoded. This information can be used for diagnostic purposes.
pCallSeqID [out]
Receives the number of times this method has been called for the current ratings packet. This information can be used for diagnostic purposes.
pTimeStart [out]
Receives the start time of the sample containing the packet.
pTimeEnd [out]
Receives the stop time of the sample containing the packet.

Return Value

Returns an HRESULT value. Possible values include those in the following table.

Return code	Description
E_POINTER	NULL pointer argument
S_OK	Success

Remarks

The returned BSTR contains binary data which might include embedded NULL characters. The caller must free the returned BSTR by calling SysFreeString.

Requirements

Header

Declared in EncDec.h.

Share via