Share via

IFileSinkFilter::GetCurFile (Compact 2013)

  • Article

3/26/2014

This 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 Value

Returns an HRESULT value. The following table shows some possible values.

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

dshow.h

Library

Strmiids.lib

See Also

Reference

IFileSinkFilter Interface
AM_MEDIA_TYPE
FreeMediaType

Other Resources

CoTaskMemFree