RemoveAt Callback Function

  • 项目

The RemoveAt function removes the attribute at the specified index in the array.

DWORD WINAPI RemoveAt(
  [in]                 _RADIUS_ATTRIBUTE_ARRAY* This,
  [in]                 DWORD dwIndex
);

Parameters

  • This
    Pointer to the RADIUS_ATTRIBUTE_ARRAY structure that represents the array of attributes from which to remove the specified attribute.

    The GetRequest and GetResponse functions return pointers to RADIUS_ATTRIBUTE_ARRAY structures.

  • dwIndex
    Specifies the index of the attribute to remove.

    Use the GetSize function to determine the size of the array. The largest index is one less than the size of the array.

Return Value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes:

Return code Description

ERROR_ACCESS_DENIED

The specified attribute is read-only.

ERROR_INVALID_PARAMETER

The index is out of range.

Remarks

When the RemoveAt function removes an attribute from the array, it decrements the index of any pre-existing attributes at higher indexes.

This function is provided by Internet Authentication Service (IAS). IAS returns a pointer to this function as a member of the RADIUS_ATTRIBUTE_ARRAY 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

Send comments about this topic to Microsoft

Build date: 10/1/2007