| title | HelpLink element | ||
|---|---|---|---|
| description | Learn the details about the HelpLink element of the Detail property, including the arguments of the HelpLink URL. | ||
| ms.date | 09/25/2024 | ||
| ms.service | reporting-services | ||
| ms.subservice | report-server-web-service | ||
| ms.topic | reference | ||
| ms.custom |
|
||
| helpviewer_keywords |
|
The HelpLink element of the Detail property is a URL string that is generated by the report server. The URL targets a Web page managed by [!INCLUDEmsCoName] Help and Support and provides more help and knowledge base articles about specific errors that occur in [!INCLUDEssRSnoversion]. The URL has the following syntax:
https://www.microsoft.com/products/ee/transform.aspx?EvtSrc=v_alue_&EvtID=value&ProdName=value&ProdVer=value
The following table lists the arguments of the HelpLink URL.
| Argument | Value |
|---|---|
| EvtSrc | "Microsoft.ReportingServices.Diagnostics.ErrorStrings.resources.Strings" |
| EvtID | The report server error code, for example, rsReservedItem. |
| ProdName | "Microsoft SQL%20Server%20Reporting%20Services". The value of the product name is URL encoded. |
| ProdVer | The version number of [!INCLUDEssRSnoversion]. A value of "8.00" indicates [!INCLUDEssVersion2000] [!INCLUDEssRSnoversion]. |
The following example illustrates the HelpLink URL that is returned for error code rsReservedItem. This error occurs when a user attempts to modify or delete a reserved item in [!INCLUDEssRSnoversion]:
https://www.microsoft.com/products/ee/transform.aspx?
EvtSrc=Microsoft.ReportingServices.Diagnostics.ErrorStrings.resources.Strings
&EvtID=rsReservedItem&ProdName=Microsoft%20SQL%20Server%20Reporting%20Services&ProdVer=8.00
You can access the HelpLink element in your code using the SoapException class.
Try
rs.DeleteItem("/Report1")
Catch e As SoapException
Console.WriteLine(e.Detail("HelpLink").InnerXml)
End Try try
{
rs.DeleteItem("/Report1");
}
catch (SoapException e)
{
Console.WriteLine(e.Detail["HelpLink"].InnerXml);
}