VMS Help  —  DCE  DCE_INTRO, dce_attr_intro, dce_attr_sch_cursor_init
 NAME
   dce_attr_sch_cursor_init - Initialize and allocate a cursor used
                              with the dce_attr_sch_scan call

 SYNOPSIS

   #include <dce/dce_attr_base.h>

   void dce_rgy_attr_cursor_init( dce_attr_sch_handle_t h,
                                  unsigned32 *cur_num_entries,
                                  dce_attr_cursor_t *cursor,
                                  error_status_t *status );

 PARAMETERS

   Input

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

   Output

   cur_num_entries
          A pointer to an unsigned 32-bit integer that specifies the
          total number of entries contained in the schema at the time
          of this call.

   cursor
          A pointer to a dce_attr_cursor_t that is initialized to the
          first entry in the the schema.

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

 DESCRIPTION

   The dce_attr_sch_cursor_init() call initializes and allocates a
   cursor used with the dce_attr_sch_scan call.  This call makes
   remote calls to initialize the cursor.  To limit the number of
   remote calls, use the dce_attr_sch_cursor_alloc() call to allocate
   cursor, but not initialize it.  If the cursor input to
   dce_attr_sch_scan has not been initialized, dce_attr_sch_scan call
   will initialize it; if it has been initialized, dce_attr_sch_scan
   advances it.

   Unlike the dce_attr_sch_cursor_alloc() call, the
   dce_attr_sch_cursor_init() call supplies the total number
   of entries found in the schema as an output parameter.

   Permissions Required

   None.

 FILES

   SYS$COMMON:[DCE$LIBRARY]DCE_ATTR_BASE.IDL
                The idl file from which dce/dce_attr_base.h was derived.

 ERRORS

   dce_attr_s_bad_binding

   dce_attr_s_no_memory

   error_status_ok

 RELATED INFORMATION

   Functions: dce_attr_intro
              dce_attr_sch_cursor_release
              dce_attr_sch_scan
              dce_attr_sch_cursor_allocate
Close Help