IWMBackupRestoreProps::SetProp method (wmsdkidl.h)

Artigo
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.]

[SetProp is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use Microsoft PlayReady. ]

The SetProp method adds a property, and specifies its name and value.

Syntax

HRESULT SetProp(
  [in] LPCWSTR           pszName,
  [in] WMT_ATTR_DATATYPE Type,
  [in] const BYTE        *pValue,
  [in] WORD              cbLength
);

Parameters

[in] pszName

Pointer to a null-terminated string containing the name.

[in] Type

Pointer to a variable containing one member of the WMT_ATTR_DATATYPE enumeration type. The current implementation of this method accepts only WMT_TYPE_STRING. Specifying a different type causes the method to return E_INVALIDARG.

[in] pValue

Pointer to a byte array containing the value of the property.

[in] cbLength

Length of pValue, in bytes.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

This method is used to set properties that are needed by the other backup restorer object interfaces.

The following table lists the predefined properties.

Property name	Type	Description
BackupPath	String	Full path to the location where the backup files must be saved.
RestorePath	String	Full path to the location where the backup files can be found and used to restore data.

Requirements

Requirement	Value
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)

Compartilhar via