IWMWriterAdvanced2::GetInputSetting method (wmsdkidl.h)

Article
4/26/2023

[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The GetInputSetting method retrieves a setting for a particular input by name.

Syntax

HRESULT GetInputSetting(
  [in]      DWORD             dwInputNum,
  [in]      LPCWSTR           pszName,
  [out]     WMT_ATTR_DATATYPE *pType,
  [out]     BYTE              *pValue,
  [in, out] WORD              *pcbLength
);

Parameters

[in] dwInputNum

DWORD containing the input number.

[in] pszName

Pointer to a wide-character null-terminated string containing the setting name. For a list of valid settings, see Input Settings.

[out] pType

Pointer to a value from the WMT_ATTR_DATATYPE enumeration type.

[out] pValue

Pointer to a byte array containing the setting. The type of date is determined by pType. Pass NULL to retrieve the size of array required.

[in, out] pcbLength

On input, pointer to the length of pValue. On output, pointer to a count of the bytes in pValue filled in by this method.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
NS_E_NOT_CONFIGURED	The input profile has not yet been set.
E_INVALIDARG	dwInputNum is larger than the number of existing inputs OR pType, pcbLength, or pszName is NULL.

Return code

Description

S_OK

The method succeeded.

NS_E_NOT_CONFIGURED

The input profile has not yet been set.

E_INVALIDARG

dwInputNum is larger than the number of existing inputs

pType, pcbLength, or pszName is NULL.

Remarks

You should make two calls to GetInputSetting for each setting you want to retrieve. On the first call, pass NULL as pValue. On return, the value pointed to by pcbLength is set to the buffer size required to hold the setting value. Then you can allocate the required amount of memory for the buffer and pass a pointer to it as pValue on the second call.

Requirements


Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 7 SDK, or later versions of the SDK
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wmsdkidl.h (include Wmsdk.h)
Library	Wmvcore.lib; WMStubDRM.lib (if you use DRM)