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(
         const wchar_t *key,
         wchar_t *value,
         UINT32 *pValueSize
)  

Parameters

key
Type: wchar_t *

[in] Null-terminated string that specifies the key of the value to retrieve.

value
Type: wchar_t *

Pointer to a buffer that receives a null-terminated string containing the value.

pValueSize
Type: UINT32 *

[in, out] Pointer to a UINT32 variable that specifies the size, in bytes, of the value buffer. On return, *pValueSize is set to the actual size of the data stored in the value buffer.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Remarks

GetMetaData retrieves a metadata tag, if any, that was stored at the current position during a recording and that matches the key specified in key. Metadata is stored during recording by calling SetMetaData and specifying the key:value pair.

Requirements

Header: Declared in xstudio.h.

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