IInternetProtocolRoot::Start Method

Starts the operation.

Syntax

Copy

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

Parameters

szUrl

[in] The address of a string value that contains the URL. For a pluggable MIME filter, this parameter contains the MIME type.

pOIProtSink

[in] The address of the protocol sink provided by the client.

pOIBindInfo

[in] The address of the IInternetBindInfo interface that the protocol gets download-specific information from.

grfPI

[in] An unsigned long integer value that contains the flags to determine whether the method parses or 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 Value

Returns one of the following values.

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 Remarks.
INET_E_xxx	Internet-specific errors. For additional information, see the URL Moniker Error Codes definitions.

Remarks

INET_E_USE_DEFAULT_PROTOCOLHANDLER can only be returned 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.

To use INET_E_USE_DEFAULT_PROTOCOLHANDLER, the pluggable protocol handler object must support aggregation. For more information, see COM Aggregation.