IStreamBufferRecordingAttribute::GetAttributeByIndex Method

This topic applies only to Windows XP Service Pack 1 or later.
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

• wIndex [in]
  Zero-based index of the attribute to retrieve.

• pulReserved [in]
  Reserved. Set this parameter to zero.

• pszAttributeName [out]
  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.

• pcchNameLength [in, out]
  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.

• pStreamBufferAttributeType [out]
  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.

• pbAttribute [out]
  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.

• pcbLength [in, out]
  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.

Requirements

See Also

IStreamBufferRecordingAttribute Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008