NDdeGetShareSecurity function

[Network DDE is no longer supported. Nddeapi.dll is present on Windows Vista, but all function calls return NDDE_NOT_IMPLEMENTED.]

Retrieves the security descriptor associated with the DDE share. This is done usually for editing.

Syntax

UINT NDdeGetShareSecurity(
  _In_  LPTSTR               lpszServer,
  _In_  LPTSTR               lpszShareName,
  _In_  SECURITY_INFORMATION si,
  _Out_ PSECURITY_DESCRIPTOR pSD,
  _In_  DWORD                cbSD,
  _Out_ LPDWORD              lpcbsdRequired
);

Parameters

lpszServer [in]

The name of the server on which the DSDM resides.

lpszShareName [in]

The name of the share whose security descriptor is to be retrieved from the DSDM. This parameter cannot be NULL.

si [in]

A SECURITY_INFORMATION value that specifies the security information to be retrieved from the security descriptor associated with the share.

pSD [out]

A pointer to a SECURITY_DESCRIPTOR structure that receives the self-relative security descriptor. This parameter can be NULL. If this parameter is NULL, the DSDM determines the size of the requested security information and returns the number of bytes needed in the lpcbsdRequired parameter along with the NDDE_BUF_TOO_SMALL error code.

cbSD [in]

The size of the pSD buffer. This parameter must be zero if pSD is NULL.

lpcbsdRequired [out]

A pointer to the variable that receives the actual size of the retrieved security descriptor. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is NDDE_NO_ERROR.

If the function fails, the return value is an error code, which can be translated into a text error message by calling NDdeGetErrorString. If the pSD parameter was NULL, it returns NDDE_BUF_TOO_SMALL.

Requirements

Requirement Value
Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
Header
Nddeapi.h
Library
Nddeapi.lib
DLL
Nddeapi.dll
Unicode and ANSI names
NDdeGetShareSecurityW (Unicode) and NDdeGetShareSecurityA (ANSI)

See also

Network Dynamic Data Exchange Overview

Network DDE Functions

SECURITY_INFORMATION

NDdeSetShareSecurity