NAME

sec_rgy_attr_sch_scan — Reads a specified number of schema entries

Synopsis

void sec_rgy_attr_sch_scan(
sec_rgy_handle_t context,
sec_attr_component_name_t schema_name,
sec_attr_cursor_t ∗cursor,
unsigned32 num_to_read,
unsigned32 ∗num_read,
sec_attr_schema_entry_t schema_entries[!],
error_status_t ∗status);

Parameters

Input

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

schema_name
Reserved for future use.

num_to_read
An unsigned 32-bit integer specifying the size of the schema_entries[!] array and the maximum number of entries to be returned. 

Input/Output

cursorA pointer to a sec_attr_cursor_t.  As input cursor must be allocated and can be initialized.  If cursor is not initialized, sec_rgy_attr_sch_scan will initialized.  As output, cursor is positioned at the first schema entry after the returned entries. 

Output

num_readA pointer an unsigned 32-bit integer specifying the number of entries returned in schema_entries[!]. 

schema_entries[!]
A sec_attr_schema_entry_t that contains an array of the returned schema entries. 

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

Description

The sec_rgy_attr_sch_scan() routine reads schema entries.  The read begins at the entry at which the input cursor is positioned and ends after the number of entries specified in num_to_read. 

The input cursor must have been allocated by either the sec_rgy_attr_sch_cursor_init() or the sec_rgy_attr_sch_cursor_alloc() call.  If the input cursor is not initialzed, sec_rgy_attr_sch_scan() initializes it; if cursor is initialized, sec_rgy_attr_sch_scan() simply advances it. 

To read all entries in a schema, make successive sec_rgy_attr_sch_scan() calls.  When all entries have been read, the call returns the message no_more_entries. 

This routine is useful as a browser. 

Permissions Required

The sec_rgy_attr_sch_scan() routine requires r permission on the attr_schema object. 

Files

/usr/include/dce/sec_rgy_attr_sch.idl
The idl file from which dce/sec_rgy_attr_sch.h was derived. 

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. 

sec_attr_bad_cursor

sec_attr_no_memory

sec_attr_svr_unavailable

sec_attr_unauthorized

error_status_ok

Related Information

Functions: sec_intro(3sec), sec_rgy_attr_sch_cursor_alloc(3sec), sec_rgy_attr_sch_cursor_init(3sec), sec_rgy_attr_sch_cursor_release(3sec).