IFileSinkFilter::GetCurFile

  • Article
 
Microsoft DirectShow 9.0

IFileSinkFilter::GetCurFile

The GetCurFile method retrieves the name and media type of the current file.

Syntax

  HRESULT GetCurFile(
  LPOLESTR *ppszFileName,
  AM_MEDIA_TYPE *pmt
);

Parameters

ppszFileName

[out] Address of a pointer that receives the name of the file, as an OLESTR type.

pmt

[out] Pointer to an AM_MEDIA_TYPE structure that receives the media type. This parameter can by NULL, in which case the method does not return the media type.

Return Values

Returns an HRESULT value. Possible values include the following.

Value Description
S_OK Success.
E_FAIL No file is opened.
E_OUTOFMEMORY Insufficient memory.
E_POINTER NULL pointer argument in ppszFileName.

Remarks

If the filter has not opened a file, the method might succeed but return NULL in the ppszFileName parameter. Check the value when the method returns.

The method allocates the memory for the string returned in ppszFileName, and the memory for the format block in the media type (if any). The caller must free them by calling CoTaskMemFree. For the media type, you can use the FreeMediaType function in the base class library.

Requirements

Header: Declared in Strmif.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also