IMSVidPlayback::get_CanStep method (segment.h)

2018-12-05

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

The get_CanStep method queries whether the input source can step frame by frame.

Syntax

HRESULT get_CanStep(
  [in]  VARIANT_BOOL fBackwards,
  [out] VARIANT_BOOL *pfCan
);

Parameters

[in] fBackwards

Use one of the following values.

Value	Description
VARIANT_FALSE	Query whether the input can step forward
VARIANT_TRUE	Query whether the input can step backward.

[out] pfCan

Pointer to a variable that receives one of the following values.

Value	Description
VARIANT_FALSE	The source cannot step in the specified direction.
VARIANT_TRUE	The source can step in the specified direction.

Return value

The method returns an HRESULT. Possible values include the following.

Return code	Description
E_POINTER	NULL pointer argument.
ERROR_INVALID_STATE	The graph is not built. Call the Build or View method on the Video Control.
S_OK	The method succeeded.

�

Note��The value ERROR_INVALID_STATE is converted to an HRESULT with the HRESULT_FROM_WIN32 macro.

�

Remarks

Call the IMSVidCtl::Build or IMSVidCtl::View method before calling this method.

Examples


VARIANT_BOOL fCan = VARIANT_FALSE;
hr = m_pPlayback->get_CanStep(VARIANT_FALSE, &fCan);

Requirements

Requirement	Value
Minimum supported client	Windows�XP [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	segment.h (include Msvidctl.h)

Share via