Aw license next

From ActiveWiki
Revision as of 11:00, 1 November 2008 by Macavity (talk | contribs) (Added in, cleanup)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


Minimum requirements
Added in version 2.1
SDKbuild 13


int aw_license_next (void)

Description

Returns attributes of the next world license in the license database.

Callback

AW_CALLBACK_LICENSE_ATTRIBUTES

Notes

The license with the next name alphabetically after the current value of AW_LICENSE_NAME is returned. To scan the entire license database, set AW_LICENSE_NAME to NULL and call aw_license_next repeatedly until it fails.

Arguments

None

Argument attributes

AW_LICENSE_NAME

Return values

RC_SUCCESS (1) (2)
RC_NOT_INITIALIZED (1)
RC_NO_INSTANCE (1)
RC_NO_CONNECTION (1)
The connection to the universe is down.
RC_NOT_AVAILABLE (1)
Instance must be owned by the root account (citizen #1 - universe administrator).
RC_UNAUTHORIZED (2)
Instance must be owned by the root account (citizen #1 - universe administrator).
RC_NO_SUCH_LICENSE (2)

(1) Possible return values when a callback is installed.

(2) Returned by the universe server.

Returned attributes

AW_LICENSE_ALLOW_TOURISTS
AW_LICENSE_COMMENT
AW_LICENSE_CREATION_TIME
AW_LICENSE_EMAIL
AW_LICENSE_EXPIRATION_TIME
AW_LICENSE_HIDDEN
AW_LICENSE_LAST_ADDRESS
AW_LICENSE_LAST_START
AW_LICENSE_NAME
AW_LICENSE_PASSWORD
AW_LICENSE_PLUGINS
AW_LICENSE_RANGE
AW_LICENSE_USERS
AW_LICENSE_VOIP

Usage

Print the names of the universe's first ten licenses.

int i;

aw_string_set (AW_LICENSE_NAME, "");

for (i = 0; i < 10; i++)
{
  if (aw_license_next () != RC_SUCCESS)
    break;
  printf ("%s\n", aw_string (AW_LICENSE_NAME));
}

See also