GetIconPath method

  • Article

Retrieves the local-system path of the Accelerator icon file.

 

Syntax

HRESULT retVal = object.GetIconPath(pbstrIconPath);

Parameters

  • pbstrIconPath [out]
    Type: BSTR

    The retrieved icon-file path.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The Accelerator icon file is always local. If a Web resource is specified when the Accelerator is installed, the icon must be downloaded to the local Windows Internet Explorer service cache before it can be used. If an icon cannot be downloaded, it is scheduled to be downloaded later.

If the icon file path begins with an at symbol (@), the path is assumed to be a resource identifier of the following form:

@path, -ID

where path is the full path to the resource module and ID is a hardware-independent icon-resource ID.

See also

IOpenServiceActivity::GetIcon