Attributes Object

The Attributes object represents the set of application-specific information. The information is published by a user who registered on the ILS server.

IIlsAttributes Interface

Back to ILS Reference

IIlsAttributes Interface

The IIlsAttributes interface is obtained from the IIlsMain::CreateAttributes method. The interface provides the methods described in this section.

EnumAttributes

GetAttribute

SetAttribute

SetAttributeName

Back to Attributes Object

IIlsAttributes::EnumAttributes

HRESULT IIlsAttributes::EnumAttributes(
    [out] IEnumIlsNames  **ppEnumAttribute);

Returns the attribute enumerator. The application enumerates the attribute name from the enumerator.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_ACCESS_CONTROL	Attribute type is ILS_ATTRTYPE_NAME_ONLY.
  ILS_E_POINTER	ppEnumAttribute is NULL.
  ILS_E_MEMORY	Unable to allocate enough memory for this request.

ppEnumAttribute

Pointer to receive an attribute enumerator.

Back to IIlsAttributes Interface

Back to Attributes Object

Back to ILS Object Listing

IIlsAttributes::GetAttribute

HRESULT IIlsAttributes::GetAttribute(
    BSTR  bstrName,
    BSTR  *pbstrValue);

Retrieves the value of the specified attribute.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_POINTER	Address of return string is NULL, or Attribute name is NULL.
  ILS_E_PARAMETER	Attribute name is empty.
  ILS_E_ACCESS_CONTROL	Attribute type is ILS_ATTRTYPE_NAME_ONLY.
  ILS_E_MEMORY	Unable to allocate enough memory for this request.
  ILS_E_FAIL	Attribute not found.

bstrName

Null-terminated string for the attribute's name.

pbstrValue

Pointer to receive a null-terminated string for the attribute's value.

Back to IIlsAttributes Interface

Back to Attributes Object

Back to ILS Object Listing

IIlsAttributes::SetAttribute

HRESULT IIlsAttributes::SetAttribute(
    BSTR  bstrName,
    BSTR  bstrValue);

Adds a new attribute if the attribute name does not exist, or replaces the attribute value with the specified value if the attribute exists, or removes the attribute if the attribute exists and the bstrValue parameter is NULL.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_POINTER	Attribute name us NULL.
  ILS_E_PARAMETER	Attribute name is empty.
  ILS_E_ACCESS_CONTROL	Attribute type is ILS_ATTRTYPE_NAME_ONLY.
  ILS_E_MEMORY	Unable to allocate enough memory for this request.

bstrName

Null-terminated string for the attribute's name.

bstrValue

Null-terminated string for the attribute's value. If the parameter is NULL, the attribute is removed.

Back to IIlsAttributes Interface

Back to Attributes Object

Back to ILS Object Listing

IIlsAttributes::SetAttributeName

HRESULT IIlsAttributes::SetAttributeName(
    BSTR  bstrName);

Allows the application to specify the name of the attribute.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_ACCESS_CONTROL	Attribute type is ILS_ATTRTYPE_NAME_ONLY.
  ILS_E_POINTER	Attribute name is NULL.
  ILS_E_PARAMETER	Attribute name is empty.
  ILS_E_MEMORY	Unable to allocate enough memory for this request.

bstrName

Name of the attribute.

If the Attributes object is of the ILS_ATTRTYPE_NAME_ONLY type, the Attributes object is used to specify which extended attributes are to be retrieved from the server.

Back to IIlsAttributes Interface

Back to Attributes Object

Back to ILS Object Listing

Last Updated: November 1, 1997
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.