PreviousNext

sec_rgy_attr_cursor_init(3sec)

Initializes a cursor used by the sec_rgy_attr_lookup_by_id call

Synopsis

#include <dce/sec_rgy_attr.h>

void sec_rgy_attr_cursor_init (
sec_rgy_handle_t context,
sec_rgy_domain_t name_domain,
sec_rgy_name_t name,
unsigned32 *cur_num_attrs,
sec_attr_cursor_t *cursor,
error_status_t *status);

Parameters

Input

context
An opaque handle bound to a registry server. Use sec_rgy_site_open( ) to acquire a bound handle.

name_domain
A value of type sec_rgy_domain_t that identifies the registry domain in which the object specified by name resides. The valid values are as follows:

sec_rgy_domain_person
The name identifies a principal.

sec_rgy_domain_group
The name identifies a group.

sec_rgy_domain_org
The name identifies an organization.

This parameter is ignored if name is policy or replist.

name
A pointer to a sec_rgy_name_t character string containing the name of the person, group, or organization to which the attribute to be scanned is attached.

Output

cur_num_attrs
A pointer to an unsigned 32-bit integer that specifies the number of attributes currently attached to the object.

cursor
A pointer to a sec_rgy_cursor_t positioned at the first attribute in the list of the object's attributes.

status
A pointer to the completion status. On successful completion, the routine returns error_status_ok. Otherwise, it returns an error.

Description
The sec_rgy_attr_cursor_init( ) routine initializes a cursor of type sec_attr_cursor_t (used with the sec_rgy_attr_lookup_by_id call) and initializes the cursor to the first attribute in the specified object's list of attributes. This call also supplies the total number of attributes attached to the object as part of its output. The cursor allocation is a local operation. The cursor initialization is a remote operation and makes a remote call to the Registry.

Use the sec_rgy_attr_cursor_release( ) call to release all resources allocated to a sec_attr_cursor_t cursor.

Permissions Required
The sec_rgy_attr_cursor_init( ) routine requires at least one permission (of any type) on the person, group, or organization to which the attribute to be scanned is attached.

Errors

The following describes a partial list of errors that might be returned. Refer to the OSF DCE Problem Determination Guide for complete descriptions of all error messages.

no such object

error_status_ok

Related Information
Functions:

sec_intro(3sec)

sec_rgy_attr_lookup_by_id(3sec)

sec_rgy_attr_cursor_release(3sec)