260 lines
8.6 KiB
Plaintext
260 lines
8.6 KiB
Plaintext
<!-- $XConsortium: read_nex.sgm /main/4 1996/08/30 15:38:46 rws $ -->
|
|
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
|
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
|
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
|
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
|
<!-- (c) Copyright 1995 Novell, Inc. -->
|
|
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
|
<!-- (c) Copyright 1995 Hitachi. -->
|
|
|
|
<RefEntry Id="CDEMX.MAN70.rsml.1">
|
|
<RefMeta>
|
|
<RefEntryTitle>csa_read_next_reminder</RefEntryTitle>
|
|
<ManVolNum>library call</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Function>csa_read_next_reminder</Function></RefName>
|
|
<RefPurpose>reads the next reminder of the given type in the specified calendar relative to a given time
|
|
</RefPurpose>
|
|
</RefNameDiv>
|
|
<!-- CDE Common Source Format, Version 1.0.0-->
|
|
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
|
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
|
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
|
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
|
<!-- (c) Copyright 1994 X.400 API Association-->
|
|
<RefSynopsisDiv>
|
|
<FuncSynopsis Remap="ANSI">
|
|
<FuncSynopsisInfo>#include <xcsa.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>CSA_return_code <Function>csa_read_next_reminder</Function></FuncDef>
|
|
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
|
<ParamDef>CSA_uint32 <Parameter>number_names</Parameter></ParamDef>
|
|
<ParamDef>CSA_attribute_reference *<Parameter>reminder_names</Parameter></ParamDef>
|
|
<ParamDef>CSA_date_time <Parameter>given_time</Parameter></ParamDef>
|
|
<ParamDef>CSA_uint32 *<Parameter>number_reminders</Parameter></ParamDef>
|
|
<ParamDef>CSA_reminder_reference **<Parameter>reminder_references</Parameter></ParamDef>
|
|
<ParamDef>CSA_extension *<Parameter>read_next_reminder_extensions</Parameter></ParamDef>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Function>csa_read_next_reminder</Function> function reads the next reminder of the specified type in
|
|
the specified calendar relative to a given time.
|
|
More than
|
|
one type of reminder may be specified.
|
|
For each reminder
|
|
type specified, the next reminder of that type after the
|
|
given time will be returned.
|
|
The owner of the calendar or
|
|
users with
|
|
<SystemItem Class="Constant">CSA_OWNER_RIGHTS</SystemItem> access right can read the next reminder for a calendar.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>ARGUMENTS</Title>
|
|
<RefSect2>
|
|
<Title>Session (Session Handle)</Title>
|
|
<Para>Opaque session handle that represents a session with the
|
|
calendaring service.
|
|
</Para>
|
|
<Para>Session handles are created by a logon function call and
|
|
invalidated with a logoff function call.
|
|
If the session
|
|
handle is invalid, then the error
|
|
<SystemItem Class="Constant">CSA_E_INVALID_SESSION_HANDLE</SystemItem> is returned.
|
|
</Para>
|
|
</RefSect2>
|
|
<RefSect2>
|
|
<Title>Number Names (Uint32)</Title>
|
|
<Para>Specifies the size of reminder_names.
|
|
</Para>
|
|
</RefSect2>
|
|
<RefSect2>
|
|
<Title>Reminder Names (Attribute Reference)</Title>
|
|
<Para>A pointer to an array of attribute references.
|
|
This is an
|
|
array of reminder attribute names.
|
|
The names are used as
|
|
search criteria to return the next reminder of each type.
|
|
If
|
|
<SystemItem Class="Constant">NULL</SystemItem>, then the first reminder after the given time will be
|
|
returned, no matter what type it is.
|
|
If an invalid
|
|
reminder type is specified, then the error
|
|
<SystemItem Class="Constant">CSA_E_INVALID_ATTRIBUTE</SystemItem> is returned.
|
|
</Para>
|
|
</RefSect2>
|
|
<RefSect2>
|
|
<Title>Given Time (Date Time)</Title>
|
|
<Para>The given date and time after which the search for the next
|
|
reminder is to begin.
|
|
If the date and time value is
|
|
incorrect, then the error
|
|
<SystemItem Class="Constant">CSA_E_INVALID_DATE_TIME</SystemItem> will be returned.
|
|
</Para>
|
|
</RefSect2>
|
|
<RefSect2>
|
|
<Title>Read Next Reminder Extensions (Extension)</Title>
|
|
<Para>A pointer to an array of
|
|
<StructName Role="typedef">CSA_extension</StructName> structures for this function.
|
|
The array may contain both
|
|
input extensions for providing additional information to
|
|
the function and output extensions for receiving
|
|
information from the function.
|
|
A value of
|
|
<SystemItem Class="Constant">NULL</SystemItem> indicates that the caller is not using any extensions.
|
|
See the extensions structure for more information.
|
|
</Para>
|
|
</RefSect2>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>RETURN VALUE</Title>
|
|
<RefSect2>
|
|
<Title>Number Reminders (Uint32)</Title>
|
|
<Para>The number of reminder reference structures returned in
|
|
reminder_references.
|
|
If no reminders were found a value of
|
|
zero is returned.
|
|
</Para>
|
|
</RefSect2>
|
|
<RefSect2>
|
|
<Title>Reminder References (Reminder Reference)</Title>
|
|
<Para>A pointer to an array of reminder reference structures.
|
|
This array is allocated by the service, and should be freed
|
|
with a single call to
|
|
&cdeman.csa.free;.</Para>
|
|
</RefSect2>
|
|
<RefSect2>
|
|
<Title>Read Next Reminder Extensions (Extension)</Title>
|
|
<Para>If output extensions were passed to the function in the
|
|
extensions list, the results from the service will be
|
|
available in the extension.
|
|
See the extensions structure for more information.
|
|
Whether the function succeeded or
|
|
not, and, if not, why.
|
|
It may be success or one of the
|
|
values listed under ERRORS below.
|
|
</Para>
|
|
</RefSect2>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>ERRORS</Title>
|
|
<Para>The
|
|
<Function>csa_read_next_reminder</Function> function returns the following error values:
|
|
</Para>
|
|
<VariableList>
|
|
<VarListEntry>
|
|
<Term>CSA_E_FAILURE</Term>
|
|
<ListItem>
|
|
<Para>There was a general failure that does not
|
|
fit the description of any other error code.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_INSUFFICIENT_MEMORY</Term>
|
|
<ListItem>
|
|
<Para>Insufficient memory was available to complete the requested operation.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_INVALID_ATTRIBUTE</Term>
|
|
<ListItem>
|
|
<Para>An attribute was specified that was not defined by this
|
|
specification and the implementation does not support the
|
|
attribute as an application specific attribute.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_INVALID_DATE_TIME</Term>
|
|
<ListItem>
|
|
<Para>An invalid date and time combination was specified.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_INVALID_FLAG</Term>
|
|
<ListItem>
|
|
<Para>A flag value in the
|
|
<Symbol Role="Variable">flags</Symbol> argument was invalid.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_INVALID_FUNCTION_EXT</Term>
|
|
<ListItem>
|
|
<Para>The function extension requested is invalid.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_INVALID_PARAMETER</Term>
|
|
<ListItem>
|
|
<Para>A function parameter was invalid.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_INVALID_SESSION_HANDLE</Term>
|
|
<ListItem>
|
|
<Para>The specified Session Handle is invalid or no longer valid
|
|
(e.g., after logging off).
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_NO_AUTHORITY</Term>
|
|
<ListItem>
|
|
<Para>The user has insufficient authority for this function.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_NOT_SUPPORTED</Term>
|
|
<ListItem>
|
|
<Para>The operation requested is not supported by this implementation.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_SERVICE_UNAVAILABLE</Term>
|
|
<ListItem>
|
|
<Para>The requested calendar service is unavailable.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_UNSUPPORTED_ATTRIBUTE</Term>
|
|
<ListItem>
|
|
<Para>An attribute was encountered that is unsupported by the calendar service.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_UNSUPPORTED_FLAG</Term>
|
|
<ListItem>
|
|
<Para>The flag requested is not supported.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>CSA_E_UNSUPPORTED_FUNCTION_EXT</Term>
|
|
<ListItem>
|
|
<Para>The specified function extension is not supported or
|
|
<SystemItem Class="Constant">CSA_EXT_REQUIRED</SystemItem> is set.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
</VariableList>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.csa.csa.h;, &cdeman.csa.add.calendar;, &cdeman.csa.add.entry;, &cdeman.csa.call.callbacks;, &cdeman.csa.delete.calendar;, &cdeman.csa.delete.entry;, &cdeman.csa.free;, &cdeman.csa.free.time.search;, &cdeman.csa.list.calendar.attributes;, &cdeman.csa.list.calendars;, &cdeman.csa.list.entries;, &cdeman.csa.list.entry.attributes;, &cdeman.csa.list.entry.sequence;, &cdeman.csa.logoff;, &cdeman.csa.logon;, &cdeman.csa.look.up;, &cdeman.csa.query.configuration;, &cdeman.csa.read.calendar.attributes;, &cdeman.csa.read.entry.attributes;, &cdeman.csa.register.callback;, <![ %CDE.C.XO; [&cdeman.csa.restore;, &cdeman.csa.save;, ]]>&cdeman.csa.unregister.callback;, &cdeman.csa.update.calendar.attributes;, &cdeman.csa.update.entry.attributes;.</Para>
|
|
</RefSect1>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
|