CopySid

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

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

Parameters

nDestinationSidLength

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

pDestinationSid

Pointer to a buffer receiving a copy of the source SID structure.

pSourceSid

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.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in winbase.h.
  Import Library: Use advapi32.lib.

See Also

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