IXStudioPlayback::GetMetaData Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Gets a file-level string metadata tag (key:value pair).

Syntax

public:
HRESULT GetMetaData(
         UINT16 *pFlags,
         const wchar_t *key,
         wchar_t *value,
         UINT32 *pValueSize
)  

Parameters

pFlags
Type: UINT16 *

[in, out, optional] One or more XSTUDIO_FILE flags indicating properties of the metadata.

key
Type: wchar_t *

[in] Null-terminated string that identifies the metadata.

value
Type: wchar_t *

Null-terminated string that contains the metadata.

pValueSize
Type: UINT32 *

[in, out] The size, in bytes, of the buffer pointed to by pValue.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Requirements

Header: Declared in xstudio.h.

Library: Use xstudioclient.lib (console) or xstudioservice.lib (desktop).