WSManPluginAuthzQueryQuotaComplete function (wsman.h)

Article
02/22/2024

Called from the WSManPluginAuthzQueryQuota plug-in entry point and must be called whether or not the plug-in can carry out the request.

Syntax

DWORD WSManPluginAuthzQueryQuotaComplete(
  [in]           WSMAN_SENDER_DETAILS *senderDetails,
  [in]           DWORD                flags,
  [in, optional] WSMAN_AUTHZ_QUOTA    *quota,
  [in]           DWORD                errorCode,
  [in, optional] PCWSTR               extendedErrorInformation
);

Parameters

[in] senderDetails

A pointer to the WSMAN_SENDER_DETAILS structure that was passed into the WSManPluginAuthzQueryQuota plug-in call.

[in] flags

Reserved for future use. Must be zero.

[in, optional] quota

A pointer to a WSMAN_AUTHZ_QUOTA structure that specifies quota information for a specific user.

[in] errorCode

Reports either a successful or failed authorization. If the authorization is successful, the code should be ERROR_SUCCESS. If a failure happens for any other reason, an appropriate error code should be used. Any error from this call will be sent back as a Simple Object Access Protocol (SOAP) fault packet.

[in, optional] extendedErrorInformation

Specifies an XML document that contains any extra error information that needs to be reported to the client. This parameter is ignored if errorCode is NO_ERROR. The user interface language of the thread should be used for localization.

Return value

The method returns ERROR_SUCCESS if it succeeded; otherwise, it returns ERROR_INVALID_PARAMETER. If ERROR_INVALID_PARAMETER is returned, either the senderDetails parameter was NULL or the flags parameter was not zero. If the method fails, the default quota is used.

Remarks

If the quota parameter is null and the errorCode is NO_ERROR, the method returns ERROR_INVALID_PARAMETER and the plug-in returns the default quota information. If the plug-in is not returning a quota, the authorization plug-in should not specify that quotas are available in the configuration because performance might be affected.

Requirements

Requirement	Value
Minimum supported client	Windows 7
Minimum supported server	Windows Server 2008 R2
Target Platform	Windows
Header	wsman.h
Library	WsmSvc.lib
DLL	WsmSvc.dll
Redistributable	Windows Management Framework on Windows Server 2008 with SP2 and Windows Vista with SP2

Share via