Share via

IStreamBufferRecordingAttribute::GetAttributeByIndex method (sbe.h)

  • Article

[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 GetAttributeByIndex method retrieves an attribute, specified by index number.

Syntax

HRESULT GetAttributeByIndex(
  [in]      WORD                       wIndex,
  [in]      ULONG                      *pulReserved,
  [out]     WCHAR                      *pszAttributeName,
  [in, out] WORD                       *pcchNameLength,
  [out]     STREAMBUFFER_ATTR_DATATYPE *pStreamBufferAttributeType,
  [out]     BYTE                       *pbAttribute,
  [in, out] WORD                       *pcbLength
);

Parameters

[in] wIndex

Zero-based index of the attribute to retrieve.

[in] pulReserved

Reserved. Set this parameter to zero.

[out] pszAttributeName

Pointer to a buffer that receives the name of the attribute, as a null-terminated wide-character string. Specify the size of the buffer in the pcchNameLength parameter. To find out the required size for the array, set pszAttributeName to NULL and check the value that is returned in pcchNameLength.

[in, out] pcchNameLength

On input, specifies the size of the buffer given in pszAttributeName, in wide characters. On output, contains the number of characters that were copied to the buffer, including the null terminator. Remember that wide characters are two bytes each.

[out] pStreamBufferAttributeType

Pointer to a variable that receives a member of the STREAMBUFFER_ATTR_DATATYPE enumeration. This value indicates the data type that you should use to interpret the attribute, which is returned in the pbAttribute parameter.

[out] pbAttribute

Pointer to a buffer that receives the attribute, as an array of bytes. Specify the size of the buffer in the pcbLength parameter. To find out the required size for the array, set pbAttribute to NULL and check the value that is returned in pcbLength.

[in, out] pcbLength

On input, specifies the size of the buffer given in pbAttribute, in bytes. On output, contains the number of bytes that were copied to the buffer.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK
 Success.
VFW_E_BUFFER_OVERFLOW
 One or both of the buffers is too small.

Requirements

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

See also

IStreamBufferRecordingAttribute Interface