Metodo IToc::GetDescription (wmcodecdsp.h)

Il metodo GetDescription recupera la descrizione, impostata da una chiamata precedente a SetDescription, del sommario.

Sintassi

HRESULT GetDescription(
  [in, out] WORD   *pwDescriptionSize,
  [out]     LPWSTR pwszDescription
);

Parametri

[in, out] pwDescriptionSize

Se pwszDescription è NULL, si tratta di un parametro di output che riceve le dimensioni, in caratteri wide, del buffer necessario per ricevere la descrizione. Se pwszDescription non è NULL, si tratta di un parametro di input che specifica le dimensioni, in caratteri wide, del buffer allocato dal chiamante a cui punta pwszDescription.

[out] pwszDescription

NULL o un puntatore a un buffer allocato dal chiamante che, al completamento, riceve la descrizione. La descrizione è con terminazione Null.

Valore restituito

Il metodo restituisce un valore HRESULT. I valori possibili includono, ma non sono limitati a, quelli indicati nella tabella seguente.

Codice restituito	Descrizione
S_OK	Il metodo è riuscito.
MF_E_BUFFERTOOSMALL	Il metodo restituisce questo codice di errore se pwszDescription non è NULL e la descrizione, incluso il carattere di terminazione NULL, è maggiore della dimensione specificata da pwDescriptionSize. In tal caso, pwDescriptionSize funge da parametro di output e riceve le dimensioni del buffer necessario.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2008 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	wmcodecdsp.h
DLL	Wmvdspa.dll

Vedi anche

IToc