ITocEntry::GetSubEntries Method

The GetSubEntries method retrieves an array of subentry indices that were set by a previous call to SetSubEntries.

Syntax

HRESULT GetSubEntries(
  [in, out]  DWORD *pdwNumSubEntries,
  [out]      WORD *pwSubEntryIndices
);

Parameters

  • pdwNumSubEntries [in, out]
    If pwSubEntryIndices is NULL, this is an output parameter that receives the number of subentries associated with this entry. If pwSubEntryIndices is not NULL, this is an input parameter that specifies the number of DWORDs in the caller-allocated array pointed to by pwSubEntryIndices.

  • pwSubEntryIndices [out]
    NULL, or a pointer to a caller-allocated array of DWORDs that receives the subentry indices.

Return Value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK

The method succeeded.

MF_E_BUFFERTOOSMALL

The method returns this error code if pwSubEntryIndices is not NULL and the number of subentries is larger than the number specified by pdwNumSubEntries. In that case, pdwNumSubEntries serves as an output parameter and receives the nunber of available subentry indices.

 

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Wmcodecdsp.h

DLL

Wmvdspa.dll

See Also

ITocEntry

SetSubEntries

 

 

Send comments about this topic to Microsoft

Build date: 4/7/2010