In This Topic ▼

IltmmWMScript::GetHeaderScript

Summary

Gets the header script at the specified index.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmWMScript_GetHeaderScript(pWMScript, Index, ScriptType, ScriptCommand, ScriptTime)
C++	HRESULT GetHeaderScript(Index, ScriptType, ScriptCommand, ScriptTime)

Parameters

IltmmWMScript *pWMScript

Pointer to an IltmmWMScript Interface.

long Index

The index of the script command to retrieve.

BSTR *ScriptType

Pointer to a variable that receives the type of script command (for example, "caption", "url", or "filename").

BSTR *ScriptCommand

Pointer to a variable that receives the type of script command. Syntax depends on the ScriptType value. For example, an "url" script command will expect the ScriptCommand text to be a fully qualified URL string.

double *ScriptTime

Pointer to a variable that receives the actual time (in seconds) when the script command should be executed.

Returns

Value	Meaning
S_OK	The function was successful.
<> S_OK	An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

See the Microsoft documentation, Using Script Commands Supported by Windows Media Player, for a complete list of script commands supported by Windows Media Player.