Contents Index Topic Contents
	Previous Topic: HlinkSimpleNavigateToMoniker Next Topic: Enumerations

HlinkSimpleNavigateToString

HRESULT HlinkSimpleNavigateToString(
    LPCWSTR szTarget,    //String to be resolved into target's moniker
    LPCWSTR szLocation,    //Optional string representing location within target
    LPCWSTR szTargetFrameName,    //Optional string naming the target frame
    IUnknown * pUnk,     //IUnknown pointer to the initiating document or object
    IBindCtx * pbc,      //Bind context object
    IBindStatusCallback * pbsc,   //Bind status callback 
    DWORD grfHLNF,       //Navigation flags
    DWORD dwReserved     //Reserved for future use
   );

Executes a hyperlink jump to a new document or object (specified in szTarget).

• Returns S_OK if a hyperlink knowing the name of its target has navigated to it successfully.

szTarget

[in] String that helps identify the hyperlink target. This string is resolved into a moniker for underlying binding operations through MkParseDisplayNameEx. If NULL, the navigation is within a document. This parameter is required.

szLocation

[in] Optional string representing the location within the hyperlink target for the new hyperlink.

szTargetFrameName

[in] Optional string naming the target frame for the hyperlink navigation. This argument only affects navigation within a document container that understands frame sets.

pUnk

[in] Address of the IUnknown interface on the document or object that is initiating the hyperlink. If NULL, it is assumed the hyperlink originates from an ActiveX-unaware application. Note that if the caller of this function is an ActiveX Control or Document Object, you must pass a valid value for this parameter in order for navigation to work correctly.

pbc

[in] Address of the IBindCtx interface on the bind context to use for any moniker binding performed during the navigation. Must not be NULL.

pbsc

[in] Address of the IBindStatusCallback interface on the bind-status-callback to use for any asynchronous moniker binding performed during the navigation. The bind-status-callback will only return the standard IUnknown methods: AddRef and QueryInterface. When navigating in a new window, the only BindStatusCallback method that gets called is GetBindInfo. If NULL, the caller is not interested in progress notification, cancellation, pausing, or low-level binding information.

grfHLNF

[in] Value taken from the HLNF enumeration.

dwReserved

[in] Reserved for future use; must be set to NULL.

The HlinkSimpleNavigateToString helper function should be used by all applications, documents, and objects that have simple navigation needs. This single function call will "do the right thing" depending on whether the navigation is originating from within a hyperlink frame or within a hyperlink-unaware application.

See also HLNF, HlinkNavigateToStringReference, HlinkSimpleNavigateToMoniker, IHlink::Navigate

---

 Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.