SyncURL Method

Microsoft Corporation

Updated June 10, 1999

Purpose

Use the SyncURL method to select the contents (.hhc) file entry for a topic that you specify.

The instance of the HTML Help ActiveX control that you reference when using the SyncURL method must specify the Contents command.

This command can be used only with a compiled help (.chm) file.

Applies to

Contents

Syntax

SyncURL(BSTR pszUrl)

PARAM name	Values
pszUrl	Specifies the topic whose corresponding contents entry you want to select.

Example

The following example shows how to use the SyncURL method to select entries in a contents (.hhc) file.

The code for the control:

<OBJECT


  id=sync


  type="application/x-oleobject"


  classid="clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11"


  codebase="hhctrl.ocx#Version=4,72,8252,0"


  width=35%


  height=25%


>


  <PARAM name="Command" value="Contents">


  <PARAM name="Item1" value="methods.hhc">


  </OBJECT>

The JavaScript code to invoke the control:

<a href=JavaScript:sync.syncURL('textpopup.htm')>Go to textpopup.htm</a>

Comments

The SyncURL method provides the same functionality as clicking the Locate button on the HTML Help Viewer toolbar.

	About methods