IXDSCodec::GetXDSPacket method (encdec.h)

Article
12/05/2018

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

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

[out] pXDSClassPkt

Receives the packet class.

[out] pXDSTypePkt

Receives the class-specific packet type.

[out] pBstrXDSPkt

Receives the packet as a BSTR value.

[out] pPktSeqID

Receives the number of ratings packets that have been decoded. This information can be used for diagnostic purposes.

[out] pCallSeqID

Receives the number of times this method has been called for the current ratings packet. This information can be used for diagnostic purposes.

[out] pTimeStart

Receives the start time of the sample containing the packet.

[out] pTimeEnd

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

Requirement	Value
Minimum supported client	Windows�XP with SP1 [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	encdec.h

Share via