Edit

IBitsTokenOptions::GetHelperTokenSid method (bits4_0.h)

  • Article

Returns the SID of the helper token if one is set.

Note  This method does not return the token.

 

Syntax

HRESULT GetHelperTokenSid(
  [out] LPWSTR *pSid
);

Parameters

[out] pSid

Returns the SID that is retrieved from the TokenInformation parameter of the GetTokenInformation function. If no SID is retrieved, this parameter is set to NULL.

Return value

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

Remarks

Older implementations effectively required that BITS users have administrator privileges in order to get the helper token SID with this method. Starting with Windows 10, version 1607, non-administrator BITS users can use this method to get the helper token SID on BITS jobs they own. This change enables non-administrator BITS users (such as background downloader services running under the NetworkService account) to use helper tokens effectively.

Specifically, the implementation has been changed to allow users without administrator privileges to get the helper token SID, as long as the SID of the caller's thread's token is the same as the SID of the job owner's user account during the IBackgroundCopyJob::QueryInterface call.

Requirements

Requirement Value
Minimum supported client Windows 7
Minimum supported server Windows Server 2008 R2
Target Platform Windows
Header bits4_0.h
Redistributable Windows Management Framework on Windows Vista with SP1, Windows Vista with SP2, and Windows Server 2008 with SP2

See also

IBitsTokenOptions