Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This method starts the operation.

Syntax

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 IInternetBindInfointerface 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 PROTOCOLFILTERDATAstructure. Otherwise, it is reserved and must be set to NULL.

Return Value

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

Header urlmon.h, urlmon.idl
Library urlmon.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also