Edit

ConfigurationSetting method - SetWindowsServiceIdentity

  • Article

Makes the Report Server Windows service run as a specified Windows user, and grants this account sufficient file system access to allow the report server to operate.

Syntax

Public Sub SetWindowsServiceIdentity(UseBuiltInAccount as Boolean, _  
    Account as String, Password as String, ByRef HRESULT as Int32)  

public void SetWindowsServiceIdentity(boolean UseBuiltInAccount,   
    string Account, string Password, out Int32 HRESULT);

Parameters

UseBuiltInAccount
Indicates whether the specified account is a built-in Windows account.

Account
The Windows account to use to run the Windows service, in the format DOMAIN\alias.

Password
The password for the account.

HRESULT
[out] Value indicating whether the call succeeded or failed.

Return value

Returns an HRESULT indicating success or failure of the method call. A value of 0 indicates that the method call was successful. A nonzero value indicates that an error occurred.

Remarks

When the UseBuiltInAccount parameter is set to true and the report server is running on Microsoft Windows 2000 or Windows XP, the value of the Name, Domain, and Password parameters are ignored and the Local system account is used.

When the UseBuiltInAccount parameter is set to true and the report server is running on Windows Server 2003, the Domain and Password properties are ignored, and the name field must contain either Builtin\NetworkService or Builtin\System or Builtin\LocalService.

The SetWindowsServiceIdentity method sets file permissions on files and folders in the report server installation directory.

The account specified in the Account parameter requires LogonAsService rights in Windows. The method grants this right to the specified account.

Requirements

Namespace: root\Microsoft\SqlServer\ReportServer\<InstanceName>\v13\Admin

Related content

MSReportServer_ConfigurationSetting members