
Methods
HRESULT GetSessionOption(
[in] DWORD dwOption,
[in, out] LPVOID pBuffer,
[in, out] DWORD *pdwBufferLength,
[in] DWORD dwReserved
);
Not currently implemented. Must return E_NOTIMPL..
HRESULT RegisterMimeFilter(
[in] IClassFactory *pCF,
[in] REFCLSID rclsid,
[in] LPCWSTR pwzType
);
Temporarily registers a pluggable MIME filter.
- Returns one of the following values:
| S_OK
| Success.
|
| E_FAIL
| The operation failed.
|
| E_NOINTERFACE
| The class factory could not be obtained.
|
- pCF
- Address of an IClassFactory interface where an IInternetProtocol object can be created.
- rclsid
- Reference to the pluggable MIME handler.
- pwzType
- String value that contains the MIME to register.
An application can register a pluggable MIME handler for a particular period when it wants to handle requests for some MIMEs by calling IInternetSession::RegisterMimeFilter. This method can be called multiple times using the same interface to register the different MIME types it wants to handle.
HRESULT RegisterNameSpace(
[in] IClassFactory *pCF,
[in] REFCLSID rclsid,
[in] LPCWSTR pwzProtocol,
[in] ULONG cPatterns,
[in] const LPCWSTR *ppwzPatterns,
[in] DWORD dwReserved
);
Temporarily registers a pluggable name space handler.
- Returns one of the following values:
| S_OK
| Success.
|
| E_FAIL
| The operation failed.
|
| E_NOINTERFACE
| The class factory could not be obtained.
|
- pCF
- Address of an IClassFactory interface where an IInternetProtocol object can be created.
- rclsid
- Reference to the pluggable name space handler.
- pwzProtocol
- String value that contains the protocol to be handled.
- cPatterns
- Unsigned long integer that indicates the number of elements in the ppwzPatterns parameter.
- ppwzPatterns
- Array of strings containing the patterns the handler will be used for.
- dwReserved
- Reserved. Must be set to zero.
An application can register a pluggable name space handler for a particular period when it wants to handle requests for some protocols by calling IInternetSession::RegisterNameSpace. If ppwzPatterns and cPatterns are NULL, the registered pluggable name space handler will be called for all protocol requests. This method can be called multiple times using the same interface to register the different name spaces it wants to handle.
HRESULT SetCache(
[in] IInternetCache *pOInetCache,
[in] DWORD dwOption
);
Not currently implemented. Must return E_NOTIMPL.
HRESULT SetSessionOption(
[in] DWORD dwOption,
[in] LPVOID pBuffer,
[in] DWORD dwBufferLength,
[in] DWORD dwReserved
);
Not currently implemented. Must return E_NOTIMPL.
Sets the options for an Internet session.
HRESULT UnregisterMimeFilter(
[in] IClassFactory *pCF,
[in] LPCWSTR pwzType
);
Unregisters a temporary pluggable MIME filter.
- Returns S_OK if successful (pluggable name space handler was removed), or E_FAIL if the pluggable name space handler was not registered.
- pCF
- Address of the IClassFactory interface that created the filter.
- pwzType
- String value that indicates the MIME that the filter was handling.
HRESULT UnregisterNameSpace(
[in] IClassFactory *pCF,
[in] LPCWSTR pszProtocol
);
Unregisters a temporary pluggable name space handler.
- Returns S_OK if successful, or E_FAIL if the pluggable name space handler was not registered.
- pCF
- Address of the IClassFactory interface that created the handler.
- pszProtocol
- String value that contains the protocol that was handled.
HRESULT CreateZoneEnumerator(
[out] DWORD *pdwEnum,
[out] DWORD *pdwCount,
[in] DWORD dwFlags
);
Creates a zone enumerator.
- pdwEnum
- Address of the double-word value that serves as the zone enumerator.
- pdwCount
- Address of a double-word value that contains the number of zones enumerated.
- dwFlags
- Reserved. Must be set to zero.
HRESULT DestroyZoneEnumerator(
[in] DWORD dwEnum
);
Destroys a zone enumerator.
- dwEnum
- Double-word enumerator that was created by IInternetZoneManager::CreateZoneEnumerator.
HRESULT GetZoneActionPolicy(
[in] DWORD dwZone,
[in] DWORD dwAction,
[out] BYTE *pPolicy,
[in] DWORD cbPolicy,
[in] URLZONEREG urlZoneReg
);
Retrieves the policy associated with the given URL action.
- dwZone
- Double-word value of the zone.
- dwAction
- Double-word value of the action.
- pPolicy
- Address of the buffer to store the policy information.
- cbPolicy
- Double-word value containing the size of the buffer.
- urlZoneReg
- URLZONEREG value that indicates the section in the registry to search.
HRESULT GetZoneAt(
[in] DWORD dwEnum,
[in] DWORD dwIndex,
[out] DWORD *pdwZone
);
Retrieves the zone associated with the specified index on the given enumerator.
- dwEnum
- Double-word value that contains the enumerator created by IInternetZoneManager::CreateZoneEnumerator.
- dwIndex
- Double-word value that contains the index of the zone in the enumerator.
- pdwZone
- Address of a double-word value that contains the zone.
The index set in dwIndex must be greater than or equal to zero and less than or equal to the value pointed to by pdwCount in the call to IInternetZoneManager::CreateZoneEnumerator.
HRESULT GetZoneAttributes(
[in] DWORD dwZone,
[in, out, unique] ZONEATTRIBUTES *pZoneAttributes
);
Retrieves the zone attributes.
- dwZone
- Double-word value that contains the zone index.
- pZoneAttributes
- Address of a ZONEATTRIBUTES variable to store the zone's attributes.
HRESULT GetZoneCustomPolicy(
[in] DWORD dwZone,
[in] REFGUID guidKey,
[out] BYTE **ppPolicy,
[out] DWORD *pcbPolicy,
[in] URLZONEREG urlZoneReg
);
Retrieves the named custom policy associated with the zone.
- Returns S_OK if the key is found and the buffer is allocated.
- dwZone
- Double-word value that contains the zone.
- guidKey
- Globally unique identifier that indicates the key to look up.
- ppPolicy
- Address of a buffer to contain the policy information.
- pcbPolicy
- Address of a double-word value that contains the size of the buffer.
- urlZoneReg
- URLZONEREG value that determines how the registry is accessed.
Not currently implemented.
HRESULT PromptAction(
[in] DWORD dwAction,
[in] HWND hwndParent,
[in] LPCWSTR pwszUrl,
[in] LPCWSTR pwszText,
[in] DWORD dwPromptFlags
);
);
Not currently implemented.
HRESULT SetZoneActionPolicy(
[in] DWORD dwZone,
[in] DWORD dwAction,
[in] BYTE *pPolicy,
[in] DWORD cbPolicy,
[in] URLZONEREG urlZoneReg
);
Sets the action policy associated with a zone.
- Returns S_OK if the action is valid.
- dwZone
- Double-word value that contains the zone index.
- dwAction
- Double-word value that contains the index number of the action.
- pPolicy
- Address of the buffer that contains the policy information.
- cbPolicy
- Double-word value that contains the size of the buffer.
- urlZoneReg
- URLZONEREG value that indicates how the registry is accessed.
HRESULT SetZoneAttributes(
[in] DWORD dwZone,
[in] ZONEATTRIBUTES *pZoneAttributes
);
Sets the zone attributes.
- Returns S_OK if successful.
- dwZone
- Double-word value that contains the zone index.
- pZoneAttributes
- Address of a ZONEATTRIBUTES value that contains the zone attributes to be set.
HRESULT SetZoneCustomPolicy(
[in] DWORD dwZone,
[in] REFGUID guidKey,
[out] BYTE *pPolicy,
[in] DWORD cbPolicy,
[in] URLZONEREG urlZoneReg
);
Sets a named custom policy associated with a zone.
- Returns S_OK if successful.
- dwZone
- Double-word value that contains the zone index.
- guidKey
- Globally unique identifier that contains the key.
- pPolicy
- Address of the buffer that contains the policy to be set.
- cbPolicy
- Double-word value that contains the size of the buffer.
- urlZoneReg
- URLZONEREG value that indicates where the the information will be set in the registry.
HRESULT GetCurMoniker(
[out] IMoniker **ppimkCur
);
Retrieves the moniker that refers to the object's persistent state.
- Returns S_OK if a valid absolute path was successfully returned, or E_INVALIDARG if the ppimkCur parameter is invalid.
- ppimkCur
- Indirect pointer to the moniker that references the object's current persistent state.
Typically, this method returns the moniker last passed to the object by means of the IPersistMoniker::Load, IPersistMoniker::Save, or IPersistMoniker::SaveCompleted method.
HRESULT IsDirty(void);
Checks an object for changes since it was last saved.
- Returns S_OK if the object has changed since it was last saved, or S_FALSE if not.
This method checks whether an object has changed since it was last saved so you can avoid losing information in objects that have not yet been saved.
See also IPersistMoniker::Save
HRESULT Load(
[in] BOOL fFullyAvailable,
[in] IMoniker *pmkSrc,
[in] IBindCtx *pbc,
[in] DWORD grfMode
);
Loads the object from its persistent state indicated by a supplied moniker.
- Returns S_OK if the object was successfully loaded, or E_INVALIDARG if one or more parameters are invalid.
- fFullyAvailable
- If TRUE, the data referred to by the moniker has already been loaded once, and subsequent binding to the moniker should be synchronous. If FALSE, an asynchronous bind operation should be launched.
- pmkSrc
- Address of a moniker that references the persistent state for the object to be loaded.
- pbc
- Address of the IBindCtx interface for the bind context to be used for any moniker binding during this method.
- grfMode
- Combination of values from the STGM enumeration, which indicates the access mode to use when binding to the persistent state. The IPersistMoniker::Load method can treat this value as a suggestion, adding more restrictive permissions if necessary. If grfMode is zero, the implementation should bind to the persistent state using default permissions.
Typically, the object will immediately bind to its persistent state through a call to the source moniker's IMoniker::BindToStorage method, requesting either the IStream or IStorage interface.
See also IPersistMoniker::Save, IPersistMoniker::SaveCompleted
HRESULT Save(
[in] IMoniker *pmkDst,
[in] IBindCtx *pbc,
[in] BOOL fRemember
);
Requests that the object save itself to the location referred to by the pmkDst parameter.
- Returns S_OK if the object was successfully saved, or E_INVALIDARG if one or more parameters are invalid.
- pmkDst
- Address of the moniker referencing the location where the object should persistently store itself.
- pbc
- Address of the IBindCtx interface for the bind context to be used for any moniker binding during this method.
- fRemember
- Indicator of whether pmkDst is to be used as the reference to the current persistent state after the save. If TRUE, pmkDst becomes the reference to the current persistent state, and the object should clear its dirty flag after the save. If FALSE, this save operation is a "Save A Copy As ..." operation. In this case, the reference to the current persistent state is unchanged, and the object should not clear its dirty flag. If pmkDst is NULL, the implementation should ignore the fRemember flag.
See also IPersistMoniker::GetCurMoniker, IPersistMoniker::Load, IPersistMoniker::SaveCompleted
HRESULT SaveCompleted(
[in] IMoniker *pmkNew,
[in] IBindCtx *pbc
);
Notifies the object that it has been completely saved, and points it to its new persisted state.
- Returns S_OK if successful, or E_INVALIDARG if one or more parameters are invalid.
- pmkNew
- Address of the moniker for the object's new persistent state. This parameter can be NULL if the moniker to the object's new persistent state is the same as the previous moniker to the object's persistent state. This optimization is allowed only if there was a prior call to IPersistMoniker::Save with the fRemember parameter set to TRUE, in which case the object need not rebind to pmkNew.
- pbc
- Address of the bind context to use for any moniker binding during this method.
See also IPersistMoniker::Load, IPersistMoniker::Save
HRESULT GetWindow(
[in] GUID guidReason,
[out] HWND *phwnd
);
Returns a handle to a window to present information in the user interface during a bind operation.
- Returns S_OK if the window handle was successfully returned, or E_INVALIDARG if the phwnd parameter is invalid.
- guidReason
- Same value as IID_IAuthenticate or IID_IHttpSecurity.
- phwnd
- Address of a window handle to the parent window to use for displaying user interface information.
Notes to implementers
If you implement this interface, you can return S_FALSE for this method to indicate that no window is available for displaying user interface information.
See also IAuthenticate, IHttpNegotiate, IWinInetInfo
HRESULT QueryInfo (
[in] DWORD dwOption,
[in, out] LPVOID pBuffer,
[in, out] DWORD *pcbBuf,
[in, out] DWORD *pdwFlags,
[in, out] DWORD *pdw Reserved
);
Retrieves the specified information from an HTTP request.
- dwOption
- DWORD value that indicates the information to be queried. Can be set to WININETINFO_OPTION_LOCK_HANDLE to return the lock handle from WinInet. Can also be one of the Option Flags values used by InternetQueryOption.
- pBuffer
- Address of the buffer where the information will be stored.
- pcbBuf
- Address of a DWORD value that indicates the size of the buffer.
- pdwFlags
- Address of a DWORD value that contains the flags controlling the query.
- pdwReserved
- Reserved. Must be set to NULL.
HRESULT RemoteQueryInfo (
[in] DWORD dwOption,
[in, out] BYTE *pBuffer,
[in, out] DWORD *pcbBuf,
[in, out] DWORD *pdwFlags,
[in, out] DWORD *pdwReserved
);
Remotely queries information about an HTTP request.
- dwOption
- DWORD value that indicates the information to be queried. Can be one of the Option Flags values used by InternetQueryOption.
- pBuffer
- Address of the buffer where the information will be stored.
- pcbBuf
- Address of a DWORD value that indicates the size of the buffer.
- pdwFlags
- Address of a DWORD value that contains the flags controlling the query.
- pdwReserved
- Reserved. Must be set to NULL.
HRESULT QueryOption (
[in] DWORD dwOption,
[in, out] LPVOID pBuffer,
[in, out] DWORD *pcbBuf
);
Retrieves the Win32 Internet function option indicated.
- dwOption
- DWORD value that indicates the option to retrieve. Can be one of the QUERYOPTION values.
- pBuffer
- Address of the buffer where the information will be stored.
- pcbBuf
- Address of a DWORD value that contains the size of the buffer.
HRESULT RemoteQueryOption (
[in] DWORD dwOption,
[in, out] BYTE *pBuffer,
[in, out] DWORD *pcbBuf
);
Remotely retrieves the Win32 Internet function option indicated.
- dwOption
- DWORD value that indicates the option to retrieve. Can be one of the QUERYOPTION values.
- pBuffer
- Address of the buffer where the information will be stored.
- pcbBuf
- Address of a DWORD value that contains the size of the buffer.
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.