SetAt Callback Function

  • Article

The SetAt function replaces the attribute at the specified index with the specified attribute.

DWORD WINAPI SetAt(
  [in]                 _RADIUS_ATTRIBUTE_ARRAY* This,
  [in]                 DWORD dwIndex,
  [in]                 RADIUS_ATTRIBUTE* pAttr
);

Parameters

  • This
    Pointer to the RADIUS_ATTRIBUTE_ARRAY structure that represents the array of attributes that contains the attribute to replace.

    The GetRequest and GetResponse functions return pointers to RADIUS_ATTRIBUTE_ARRAY structures.

  • dwIndex
    Specifies the index of the attribute to replace.

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

  • pAttr
    Pointer to a RADIUS_ATTRIBUTE structure. The attribute represented by this structure replaces the attribute at the specified index.

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_INVALID_PARAMETER

The index is out of range, or either this parameter or pAttr is NULL.

ERROR_ACCESS_DENIED

The attribute to be set is read-only.

Remarks

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