IOPMVideoOutput::Configure method (opmapi.h)

Article
02/22/2024

Configures a video output. This method sends an Output Protection Manager (OPM) or Certified Output Protection Protocol (COPP) command to the driver.

Syntax

HRESULT Configure(
  [in] const OPM_CONFIGURE_PARAMETERS *pParameters,
  [in] ULONG                          ulAdditionalParametersSize,
  [in] const BYTE                     *pbAdditionalParameters
);

Parameters

[in] pParameters

Pointer to an OPM_CONFIGURE_PARAMETERS structure that contains the command. For a list of OPM commands, see OPM Commands.

[in] ulAdditionalParametersSize

The size of the pbAdditionalParameters buffer, in bytes.

[in] pbAdditionalParameters

Pointer to a buffer that contains additional information for the command.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method is equivalent to the IAMCertifiedOutputProtection::ProtectionCommand method in COPP.

This method supports both OPM semantics and COPP semantics. COPP semantics are supported for backward compatibility; new applications should use OPM semantics.

OPM Semantics

Some OPM commands require additional configuration information to be passed in the pbAdditionalParameters parameter. The ulAdditionalParametersSize parameter specifies the size of the additional data.

COPP Semantics

The pbAdditionalParameters parameter must be NULL, and ulAdditionalParametersSize must be zero.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	opmapi.h