Share via

IXACTCue::GetState

  • Article

IXACTCue::GetState

Retrieves the current operating state of a cue.

[Content-driven]

  HRESULT 
  GetState(
  DWORD *pdwState
);

Parameters

  • pdwState
    Flags indicating the state of the cue. The flags are as follows:

Return Values

Returns S_OK if successful, an error code otherwise.

Remarks

This function informs the caller what activity the cue is performing at the moment the call is made. The state returned from GetState indicates only the current condition.

Only XACT_CUESTATE_PAUSED is used in combination with other state flags. In other words, the GetState might return a state value with XACT_CUESTATE_PREPARING set or XACT_CUESTATE_PLAYING set, but never with both (since both conditions cannot both be true at the same time). However, GetState may return a state value with both XACT_CUESTATE_PLAYING and XACT_CUESTATE_PAUSED flags set, to signify that the cue is paused while playing.

For more information on using this method, see Managing XACT Resources and Notifications.

Requirements

Header: Declared in Xact.h.

Library: Use Xact.lib.

See Also

IXACTCue