CopySid

The CopySid function copies a security identifier (SID) to a buffer.

BOOL CopySid(
  DWORD nDestinationSidLength,  // size of SID buffer
  PSID pDestinationSid,         // SID buffer
  PSID pSourceSid               // source SID
);

Parameters

nDestinationSidLength

[in] Specifies the length, in bytes, of the buffer receiving the copy of the SID.

pDestinationSid

[out] Pointer to a buffer that receives a copy of the source SID structure.

pSourceSid

[in] Pointer to a SID structure the function copies to the buffer pointed to by the pDestinationSid parameter.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

An application can use the CopySid function to make a copy of a SID in an access token (in a TOKEN_GROUPS structure, for instance) to use in an access-control entry.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Header: Declared in Winbase.h; include Windows.h.
  Library: Use Advapi32.lib.

See Also

Access Control Overview, Access Control Functions, AllocateAndInitializeSid, EqualSid, GetLengthSid, GetSidIdentifierAuthority, GetSidLengthRequired, GetSidSubAuthority, GetSidSubAuthorityCount, InitializeSid, IsValidSid, SID