Share via

IStreamBufferRecordingAttribute::GetAttributeByName Method

  • Article

This topic applies only to Windows XP Service Pack 1 or later.
The GetAttributeByName method retrieves an attribute, specified by name.

Syntax

HRESULT GetAttributeByName(
  [in]       LPCWSTR pszAttributeName,
  [in]       ULONG *pulReserved,
  [out]      STREAMBUFFER_ATTR_DATATYPE *pStreamBufferAttributeType,
  [out]      BYTE *pbAttribute,
  [in, out]  WORD *pcbLength
);

Parameters

  • pszAttributeName [in]
    Wide-character string that contains the name of the attribute.

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

  • 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.

Return code Description

S_OK

Success.

VFW_E_BUFFER_OVERFLOW

The buffer given in pbAttribute is too small.

Requirements

Header Declared in Sbe.h.

See Also

IStreamBufferRecordingAttribute Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008