IWMHeaderInfo::GetScript

The GetScript method returns the type and command strings, and time of a script, if its index is specified.

Syntax

HRESULT GetScript(
  WORD  wIndex,
  WCHAR*  pwszType,
  WORD*  pcchTypeLen,
  WCHAR*  pwszCommand,
  WORD*  pcchCommandLen,
  QWORD*  pcnsScriptTime
);

Parameters

wIndex

[in] Word containing the index.

pwszType

[out] Pointer to a wide-character NULL-terminated string containing the type.

pcchTypeLen

[in, out] On input, specifies a pointer to a variable containing the length of the pwszType array in wide characters (two bytes). On output, and if the method succeeds, the variable contains the actual length of the string loaded into pwszType.

pwszCommand

[out] Pointer to a wide-character NULL-terminated string containing the command.

pcchCommandLen

[in, out] On input, specifies a pointer to a variable containing the length of the pwszCommand array in wide characters (two bytes). On output, and if the method succeeds, the variable contains the actual length of the command string.

pcnsScriptTime

[out] Pointer to variable specifying the script time in 100-nanosecond increments.

Return Values

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

Return code	Meaning
NS_E_INVALID_STATE	The object is not in a configurable state.
E_UNEXPECTED	The method failed for an unspecified reason.

See Also

Previous

Next