IInternetProtocolRoot::Start

  • Article

This method starts the operation.

HRESULT Start(
  LPCWSTR szUrl,
  IInternetProtocolSink* pOIProtSink,
  IInternetBindInfo* pOIBindInfo,
  DWORD grfPI,
  HANDLE_PTR dwReserved
);

Parameters

  • szUrl
    [in] Address of a string value that contains the URL. For a pluggable MIME filter, this parameter contains the MIME type.
  • pOIProtSink
    [in] Address of the protocol sink provided by the client.
  • pOIBindInfo
    [in] Address of the IInternetBindInfo interface from which the protocol gets download-specific information.
  • grfPI
    [in] Unsigned long integer value that contains the flags that determine if the method only parses or if it parses and downloads the URL. This can be one of the PI_FLAGS values.
  • dwReserved
    [in] For pluggable MIME filters, contains the address of a PROTOCOLFILTERDATA structure. Otherwise, it is reserved and must be set to NULL.

Return Values

Returns one of the values shown in the following table.

Value Description
S_OK Success.
E_PENDING The operation started and will complete asynchronously.
INET_E_USE_DEFAULT_PROTOCOLHANDLER The handler cannot handle this URL, so the default handler should be used. See the Remarks section below.
INET_E_xxx Internet-specific errors. For additional information, see the URL Moniker Error Codes definitions.

Remarks

INET_E_USE_DEFAULT_PROTOCOLHANDLER can be returned only by a pluggable namespace handler or MIME filter. Only a single, permanently registered asynchronous pluggable protocol handler can be assigned to a particular scheme (such as FTP), so there are no other handlers to default to.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Urlmon.h, Urlmon.idl.
Link Library: Urlmon.lib.

See Also

IInternetBindInfo

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.