DMUS_SCRIPT_ERRORINFO

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

DMUS_SCRIPT_ERRORINFO

The DMUS_SCRIPT_ERRORINFO structure contains information about a script error.

Syntax

typedef struct _DMUS_SCRIPT_ERRORINFO {
  DWORD   dwSize;
  HRESULT hr;
  ULONG   ulLineNumber;
  LONG    ichCharPosition;
  WCHAR   wszSourceFile[DMUS_MAX_FILENAME];
  WCHAR   wszSourceComponent[DMUS_MAX_FILENAME];
  WCHAR   wszDescription[DMUS_MAX_FILENAME];
  WCHAR   wszSourceLineText[DMUS_MAX_FILENAME];
} DMUS_SCRIPT_ERRORINFO;

Members

dwSize

Size of this structure, in bytes. This member must be initialized to sizeof(DMUS_SCRIPT_ERRORINFO) before the structure is passed to any of the IDirectMusicScript8 methods.

hr

Result code obtained from DirectMusic or the script engine.

ulLineNumber

Line number in the script where the error occurred.

ichCharPosition

Position in the line where a syntax error was found, if wszSourceLineText contains a string.

wszSourceFile

File name of the script.

wszSourceComponent

Name of the component that generated the error. For example, this could be DirectMusic or the script parsing engine.

wszDescription

Description of the error.

wszSourceLineText

Text of the script line where a syntax error occurred. If the error is not in the syntax, this is an empty string.

Requirements

  Header: Declared in dmusici.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.