Share via


ImpersonateClient Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The ImpersonateClient property exposes the security context for non-administrative users running xp_cmdshell.

Syntax

object
.ImpersonateClient [=value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list
  • value
    TRUE or FALSE

Data Type

Boolean

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetImpersonateClient(LPBOOL pRetVal);
HRESULT SetImpersonateClient(BOOL NewValue);

Remarks

xp_cmdshell, a Microsoft SQL Server system stored procedure, executes an operating system command, returning any results of command execution as text.

If TRUE, xp_cmdshell runs in the security context of the client connection.

If FALSE, xp_cmdshell runs in the security context of SQL Server Agent. The default is FALSE.

Applies To:

IntegratedSecurity Object