SYNOPSIS

int MGOanalsubscription (Subscription **sub, Subscription *lst, int code, int *map);

DESCRIPTION

The MGOanalsubscription() function analyzes a list of subscriptions and returns permit/deny information for a particular subscription. The subscription list (obtained by a call to MGOgetsubscriptions()) is passed through lst. The target subscription's reference source code is specified by code. Returns one of the following values:

• 1 - Target subscription is implicitly permitted
• 2 - Target subscription is implicitly denied
• 3 - Target subscription is explicitly permitted
• 4 - Target subscription is explicitly denied
• 5 - Target subscription is marked currently subscribed

An explicit subscription means that the subscription was added explicitly for this uwnetid. An implicit subscription means that the subscription was implied by virtue of being in a particular validation group. Note that odd return values denote a permit; even values denote a deny. In addition, the sub pointer is set to the matched subscription from the list.

The map variable details the types of permissions and denials on the target subscription. If specified, it returns the following information:

• Bit 0 - Subscription is implicitly permitted
• Bit 1 - Subscription is implicitly denied
• Bit 2 - Subscription is explicitly permitted
• Bit 3 - Subscription is explicitly denied

Note: A subscription may be marked subscribed, yet map is empty, which typically means that the subscribee is not (or no longer) entitled to this subscription. At some future time the subscription will probably be revoked.

RETURN VALUE

Returns one of the above values upon success, or 0 if the target subscription was not found in the list.

ERRORS

• MGO_E_MAR - One or more of the required arguments were missing

AUTHENTICATION LEVEL

none

SEE ALSO

MGOfreesubscription(), MGOgetsubscriptions(), MGOselrsubscription(), MGOzero()