IDMAChannel::GetLabel
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method gets the textual label for the DMA channel and a GUID for a vendor-specific labeling schema. The label can be used for identification of the data type that the DMA channel is intended to accept in the context of a set media type.
Syntax
HRESULT GetLabel(
GUID* puuidLabelSystem,
WCHAR* labelBuf,
DWORD LabelBufSz
);
Parameters
- puuidLabelSystem
[out] Pointer to a buffer that holds the returning GUID for the labeling schema used. The GUID can be used to translate between different labels used by vendors for the same purpose data. This value cannot be NULL.
- labelBuf
[out] Pointer to the caller's buffer in order to return a label. This value cannot be NULL.
- LabelBufSz
[in] Count of WCHARs in labelBuf, including the null terminator.
Return Value
The following table shows a list of possible return values.
| Return value | Description |
|---|---|
S_OK |
The label is retrieved successfully. |
E_OUTOFMEMORY |
The size specified for a label is not enough to accommodate the label. |
E_POINTER |
One or more pointers passed are null. |
Remarks
Labeling allows the assigning of labels to DMA channels without the knowledge of the requirements of client software. Late binding is possible by storing necessary mapping in the system registry. It is currently unused by DVD Navigator, however, its use is reserved nevertheless for future releases.
This method is intended for the identification of associated data ports by the playback middleware in case of multiple DMA channels.
The middleware expects the length of this label to be 256 characters or less.
Requirements
| Header | dvddrvr.idl |
| Windows Embedded CE | Windows CE .NET 4.0 and later |