Name

dce_attr_sch_scan - Reads a specified number of schema entries

Synopsis

#include <dce/dce_attr_base.h> void dce_attr_sch_scan(
dce_attr_sch_handle_t h,
dce_attr_cursor_t ∗cursor,
unsigned32 num_to_read,
unsigned32 ∗num_read,
dce_attr_schema_entry_t schema_entries[],
error_status_t ∗status);

Parameters

Input

hAn opaque handle bound to a schema object.  Use dce_attr_sch_bind() to acquire the handle. 

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 dce_attr_cursor_t.  As input cursor must be allocated and can be initialized.  If cursor is not initialized, dce_attr_sch_scan will initialize it.  As output, cursor is positioned at the first schema entry after the returned entries. 

Output

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

schema_entries[]
A dce_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 dce_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 dce_attr_sch_cursor_init() or the dce_attr_sch_cursor_alloc() routine.  If the input cursor is not initialized, dce_attr_sch_scan() initializes it; if cursor is initialized, dce_attr_sch_scan() simply advances it. 

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

This routine is useful as a browser. 

Permissions Required

The dce_attr_sch_scan() routine requires requires appropriate permissions on the schema object.  These permissions are managed by the target server. 

Files

/usr/include/dce/dce_attr_base.idl
The idl file from which dce/dce_attr_base.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. 

dce_attr_s_bad_binding

dce_attr_s_bad_cursor

error_status_ok

Related Information

Functions: dce_attr_intro(3dce), dce_attr_sch_cursor_alloc(3dce), dce_attr_sch_cursor_init(3dce), dce_attr_sch_cursor_release(3dce).