Aw citizen delete

From ActiveWiki
Jump to: navigation, search


Minimum requirements
Added in version 2.1
SDKbuild 13


int aw_citizen_delete (int citizen)

Description

Deletes an existing citizen.

Callback

AW_CALLBACK_CITIZEN_RESULT

Arguments

citizen
Citizen number.

Argument attributes

None

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_CITIZEN (2)
RC_UNABLE_TO_DELETE_CITIZEN (2)
Database error.

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

(2) Returned by the universe server.

Returned attributes

AW_CITIZEN_NUMBER

Usage

int rc;

rc = aw_citizen_delete (4711);
if (rc != RC_SUCCESS)
  printf ("Unable to delete citizen (reason %d)\n", rc);
else
  puts ("Citizen deleted");

See also