IUpdateEndpointProvider::GetServiceEndpoint method
Requests an endpoint that is used to connect to a service.
Syntax
HRESULT GetServiceEndpoint(
[in] GUID ServiceId,
[in] UpdateEndpointType endpointType,
[in] UpdateEndpointProxySettings proxySettings,
[in] HANDLE_PTR hUserToken,
[in] BOOL fRefreshOnline,
[out] BSTR *pbstrEndpointLoc
);
Parameters
-
ServiceId [in]
-
Identifies the service to be updated.
-
endpointType [in]
-
Identifies the type of endpoint implemented by the service.
The UpdateEndpointType enumeration defines the following constants.
-
uetClientServer
-
A client-server endpoint that is used to connect to the update service.
-
uetReporting
-
A Reporting endpoint that is used when the client reports the results of scans, downloads, and installs back to the update service
-
uetWuaSelfUpdate
-
A Self-Update endpoint that is used when the client computer contacts an update service to see whether there is a new version of the Windows Update Agent client software.
-
uetRegulation
-
A Regulation endpoint that is used when the client computer contacts the regulation service to act on a particular update that is applicable to the target computer.
-
uetSimpleTargeting
-
A Simple-Targeting endpoint that is used only with private services (WSUS servers in corporate environments).
proxySettings [in]
Identifies the settings that are used when connecting to a proxy server.
hUserToken [in]
Contains a token handle object that represents the user. The endpoint provider uses this token to determine which proxy settings and credentials to use.
fRefreshOnline [in]
Indicates weather WUA requests a new token. True indicates that a new token is requested. False indicates that a new or cached token is requested. See Remarks for more information.
pbstrEndpointLoc [out]
Specify the URL used to communicate with the service. For example, for a client-server endpoint this would be the URL to the client server service. See Remarks for more information.
Return value
Returns S_OK if successful. Otherwise, returns a COM or Windows error code.
Remarks
WUA typically sets the fRefreshOnline parameter to false when this method is first called, then if a connection error occurs WUA sets that parameter to true when the method is called again. However, the implementation of this method can request a new token from a Security Token Service (STS) or provide a cached token at any time.
If the endpoint does not need authentication, then the caller can connect to the service using only the URL specified by the pbstrEndpointLoc parameter.
If the endpoint does need authentication, then the caller can use the URL specified by the pbstrEndpointLoc parameter and the data provided by the other parameters.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows XP, Windows 2000 Professional with SP3 [desktop apps only] |
| Minimum supported server |
Windows Server 2003, Windows 2000 Server with SP3 [desktop apps only] |
| Header |
|
| IDL |
|
| Library |
|
| DLL |
|
See also