GetResponse Callback Function

The GetResponse function returns the attributes that are sent in the response if the final outcome of request processing matches the specified response type.

PRADIUS_ATTRIBUTE_ARRAY WINAPI GetResponse(
  [in]                 _RADIUS_EXTENSION_CONTROL_BLOCK* This,
  [in]                 RADIUS_CODE rcResponseType
);

Parameters

  • This
    Pointer to a RADIUS_EXTENSION_CONTROL_BLOCK structure. IAS passes the Extension DLL a pointer to this structure when it calls the RadiusExtensionProcess2 function.

  • rcResponseType
    Specifies the response type. This parameter must be one of the values enumerated by the RADIUS_CODE enumeration type. Otherwise, the function fails, returning NULL.

Return Value

If the function succeeds, the return value is a pointer to a RADIUS_ATTRIBUTE_ARRAY structure that represents the attributes in the RADIUS response.

If the function fails, the return value is a NULL pointer.

Remarks

An Extension DLL can use GetResponse to retrieve and modify the attributes for any valid response type regardless of the request's current disposition. For example, an Extension DLL could set the response type to rcAccessAccept, but still add attributes to those returned in the case of an rcAccessReject. The response specified by the Extension DLL (rcAccessAccept in this example) could be overridden during further processing.

To modify the attributes, the Extension DLL uses the functions provided as members of the RADIUS_ATTRIBUTE_ARRAY structure.

This function is provided by Internet Authentication Service (IAS). IAS returns a pointer to this function as a member of the RADIUS_EXTENSION_CONTROL_BLOCK structure.

Requirements

Server

Requires Windows ServerĀ 2008 or Windows ServerĀ 2003.

Header

Declared in AuthIf.h.

See Also

About Internet Authentication Service
Internet Authentication Service Reference
Internet Authentication Service Functions
RADIUS_ATTRIBUTE_ARRAY
RADIUS_CODE
RADIUS_EXTENSION_CONTROL_BLOCK
SetResponseType

Send comments about this topic to Microsoft

Build date: 10/1/2007