| Microsoft DirectX 8.1 (C++) |
The get_DefaultLocator method retrieves the default Locator on the local system.
Syntax
HRESULT get_DefaultLocator(
ILocator** ppLocatorVal
);
Parameters
ppLocatorVal
[out] Address of a pointer that receives the returned ILocator interface.
Return Values
Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.
Remarks
It is the application's responsibility to provide a default locator for the tuning space if one is needed. It is not required for a tuning space to have a default locator. In some cases an application will be submitting tune requests to a tuning space that requires a locator with multiple properties to be set. This method provides a convenient place for the application to store such a locator, so that it only has to create it one time.
If no default locator has been set by the application, this method will return a NULL ILocator pointer but still succeed, so the application should test the validity of the returned pointer before attempting to use it. Simply testing the HRESULT is not sufficient.
The default locator can be used as a starting point for the IScanningTuner object after installation.
See Also