ORGetKeySecurity function

Retrieves a copy of the security descriptor protecting the specified open registry key in an offline registry hive.

Syntax

DWORD ORGetKeySecurity(
  _In_      ORHKEY               Handle,
  _In_      SECURITY_INFORMATION SecurityInformation,
  _Out_opt_ PSECURITY_DESCRIPTOR pSecurityDescriptor,
  _Inout_   PDWORD               lpcbSecurityDescriptor
);

Parameters

Handle [in]

A handle to an open registry key in an offline registry hive.

SecurityInformation [in]

A SECURITY_INFORMATION value that indicates the requested security information.

pSecurityDescriptor [out, optional]

A pointer to a buffer that receives a copy of the requested security descriptor. This parameter can be NULL.

lpcbSecurityDescriptor [in, out]

A pointer to a variable that specifies the size, in bytes, of the buffer pointed to by the pSecurityDescriptor parameter. When the function returns, the variable contains the number of bytes written to the buffer.

Return value

If the function succeeds, the function returns ERROR_SUCCESS.

If the function fails, it returns a nonzero error code defined in Winerror.h. You can use the FormatMessage function with the FORMAT_MESSAGE_FROM_SYSTEM flag to get a generic description of the error.

If the buffer specified by the pSecurityDescriptor parameter is too small, the function returns ERROR_INSUFFICIENT_BUFFER and the lpcbSecurityDescriptor parameter contains the number of bytes required for the requested security descriptor.

Requirements

Requirement	Value
Redistributable	Windows Offline Registry library version 1.0 or later
Header	Offreg.h
DLL	Offreg.dll

See also

ORDeleteKey

OROpenKey

ORSetKeySecurity

SECURITY_INFORMATION