Share via


IStreamBufferRecordControl::GetRecordingStatus method (sbe.h)

[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 GetRecordingStatus method retrieves the status of the recording.

Syntax

HRESULT GetRecordingStatus(
  [out] HRESULT *phResult,
  [out] BOOL    *pbStarted,
  [out] BOOL    *pbStopped
);

Parameters

[out] phResult

Pointer to a variable that receives an HRESULT value. The HRESULT value indicates the current status of writing or closing the file. This parameter can be NULL.

[out] pbStarted

Pointer to a variable that receives a Boolean value, indicating whether the recording has started,

Value Description
TRUE The recording has started.
FALSE The recording has not started.

This parameter can be NULL.

[out] pbStopped

Pointer to a variable that receives a Boolean value, indicating whether recording has been stopped.

Value Description
TRUE The recording has stopped.
FALSE The recording has not stopped, or has not started yet.

This parameter can be NULL.

Return value

Returns an HRESULT. Possible values include those in the following table.

Return code Description
S_OK
The method succeeded.

Remarks

This method reports the status of the Start and Stop methods, which themselves are asynchronous.

Requirements

Requirement Value
Minimum supported client Windows�XP with SP1 [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header sbe.h

See also

IStreamBufferRecordControl Interface