Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers

am_properties_get_positive_number()

Retrieves a positive integer value associated with a specified key from the specified properties object.

Syntax

#include "am_properties.h"
AM_EXPORT am_status_t
am_properties_get_unsigned(am_properties_t properties, 
                           const char *key,
                           unsigned long default_value
                           unsigned long *value_ptr);

Parameters

This function takes the following parameters:

properties

Pointer to a properties object.

key

Pointer to the key in the properties object.

default_value

Value to return if none is defined for the specified key.

value_ptr

Pointer to the location where the returned integer will be stored.

Returns

This function returns the unsigned integer value associated with the specified key.