Initial import of the CDE 2.1.30 sources from the Open Group.
This commit is contained in:
Peter Howkins
287
cde/doc/C/guides/man/m3_csa/add_cale.sgm
Normal file
287
cde/doc/C/guides/man/m3_csa/add_cale.sgm
Normal file
@@ -0,0 +1,287 @@
|
||||
<!-- $XConsortium: add_cale.sgm /main/5 1996/08/30 15:32:18 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.MAN52.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_add_calendar</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_add_calendar</Function></RefName>
|
||||
<RefPurpose>add a calendar to the calendar service
|
||||
</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_add_calendar</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_calendar_user *<Parameter>user</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 <Parameter>number_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute *<Parameter>calendar_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>add_calendar_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_add_calendar</Function> function creates a calendar on the calendar service.
|
||||
If
|
||||
the user does not have sufficient authority to add a
|
||||
calendar to the service, the error
|
||||
<SystemItem Class="Constant">CSA_E_NO_AUTHORITY</SystemItem> is returned.
|
||||
If the calendar already exists the error
|
||||
<SystemItem Class="Constant">CSA_E_CALENDAR_EXISTS</SystemItem> is returned.
|
||||
</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.
|
||||
The session handle may be
|
||||
<SystemItem Class="Constant">NULL</SystemItem> if the calendar service does not require a session to be
|
||||
established in order to add a calendar.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>User (Calendar User)</Title>
|
||||
<Para>A pointer to a calendar user structure.
|
||||
This specifies the
|
||||
user and name of the calendar to be added to the calendar
|
||||
service.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Number Attributes (Uint32)</Title>
|
||||
<Para>The number of elements in
|
||||
<Emphasis>calendar_attributes</Emphasis> argument.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Calendar Attributes (Attributes)</Title>
|
||||
<Para>A pointer to an array of attribute structures that specify
|
||||
the calendar attributes for the new calendar.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Add CalendarExtensions (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>Add Calendar 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_add_calendar</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_CALENDAR_EXISTS</Term>
|
||||
<ListItem>
|
||||
<Para>The specified calendar already exists.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_DISK_FULL</Term>
|
||||
<ListItem>
|
||||
<Para>Insufficient disk space was available to complete
|
||||
the requested operation (this may refer to local or shared disk space).
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_ATTRIBUTE_VALUE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid attribute value was specified for an attribute.
|
||||
</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_INAVLID_SESSION_HANDLE</Term>
|
||||
<ListItem>
|
||||
<Para></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_USER</Term>
|
||||
<ListItem>
|
||||
<Para>The specified calendar user is invalid.
|
||||
</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_READONLY</Term>
|
||||
<ListItem>
|
||||
<Para></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_TEXT_TOO_LARGE</Term>
|
||||
<ListItem>
|
||||
<Para>The size of the text string passed to the implementation is too large.
|
||||
</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_CHARACTER_SET</Term>
|
||||
<ListItem>
|
||||
<Para>The character set requested is not supported.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is not supported.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>The specified enumerated value is not valid.
|
||||
</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.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.read.next.reminder;, &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-->
|
||||
268
cde/doc/C/guides/man/m3_csa/add_entr.sgm
Normal file
268
cde/doc/C/guides/man/m3_csa/add_entr.sgm
Normal file
@@ -0,0 +1,268 @@
|
||||
<!-- $XConsortium: add_entr.sgm /main/4 1996/08/30 15:32:48 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.MAN53.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_add_entry</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_add_entry</Function></RefName>
|
||||
<RefPurpose>add an entry to the specified calendar
|
||||
</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_add_entry</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 <Parameter>number_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute *<Parameter>entry_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_entry_handle *<Parameter>entry</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>add_entry_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_add_entry</Function> function adds a new entry to a calendar.
|
||||
The handle for
|
||||
the new entry is returned.
|
||||
Only the owner of the calendar,
|
||||
users with
|
||||
<SystemItem Class="Constant">CSA_OWNER_RIGHTS,</SystemItem> users with
|
||||
<SystemItem Class="Constant">CSA_INSERT_PUBLIC_ENTRIES,</SystemItem> user with
|
||||
<SystemItem Class="Constant">CSA_INSERT_CONFIDENTIAL_ENTRIES,</SystemItem> or users with
|
||||
<SystemItem Class="Constant">CSA_INSERT_PRIVATE_ENTRIES</SystemItem> access rights can add entries to the 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 Attributes (Uint32)</Title>
|
||||
<Para>Specifies the number of attributes in the
|
||||
<Emphasis>entry_attributes</Emphasis> argument.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Entry Attributes (Attribute)</Title>
|
||||
<Para>A pointer to an array of entry attributes that will be used
|
||||
to define the new entry.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Add Entry 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>Entry (Entry Handle)</Title>
|
||||
<Para>A pointer to the handle for the new entry.
|
||||
This handle is
|
||||
allocated by the service, and should be freed with a single
|
||||
call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Add Entry 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_add_entry</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_DISK_FULL</Term>
|
||||
<ListItem>
|
||||
<Para>Insufficient disk space was available to complete
|
||||
the requested operation (this may refer to local or shared disk space).
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_ATTRIBUTE_VALUE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid attribute value was specified for an attribute.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is invalid.
|
||||
</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_RULE</Term>
|
||||
<ListItem>
|
||||
<Para>The implementation does not understand the exception or recurrence rule.
|
||||
</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_READ_ONLY</Term>
|
||||
<ListItem>
|
||||
<Para>An attempt was made to update a readonly attribute.
|
||||
</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_TEXT_TOO_LARGE</Term>
|
||||
<ListItem>
|
||||
<Para>The size of the text string passed to the implementation is too large.
|
||||
</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_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is not supported.
|
||||
</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.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.read.next.reminder;, &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-->
|
||||
251
cde/doc/C/guides/man/m3_csa/call_cal.sgm
Normal file
251
cde/doc/C/guides/man/m3_csa/call_cal.sgm
Normal file
@@ -0,0 +1,251 @@
|
||||
<!-- $XConsortium: call_cal.sgm /main/4 1996/08/30 15:33:11 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.MAN54.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_call_callbacks</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_call_callbacks</Function></RefName>
|
||||
<RefPurpose>force the invocation of the callback functions associated with the specified callback list(s)
|
||||
</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_call_callbacks</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_flags <Parameter>reason</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>call_callbacks_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_call_callbacks</Function> function causes the service to call the registered callback
|
||||
functions associationed with the specified callback
|
||||
list(s).
|
||||
The service will process each specified callback
|
||||
list and call the registered callback functions if there
|
||||
have been changes that would trigger the callbacks of that
|
||||
type.
|
||||
The order in which callbacks are invoked is
|
||||
implementation specific.
|
||||
</Para>
|
||||
<RefSect2>
|
||||
<Title>Session (Session Handle)</Title>
|
||||
<Para>Opaque session handle that represents a session with the
|
||||
calendaring service.
|
||||
</Para>
|
||||
<Para>If a valid session handle is specified, the callback
|
||||
functions registered with that session are invoked.
|
||||
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>Reason (Flags)</Title>
|
||||
<Para>A bitmask of flags.
|
||||
Unspecified flags should always be
|
||||
passed as 0.
|
||||
Undocumented flags are reserved.
|
||||
Each flag
|
||||
corresponds to a callback activity.
|
||||
Flag settings
|
||||
include:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_CALENDAR_LOGON</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked when a the
|
||||
calendar is accessed by a user.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_CALENDAR_DELETED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked when a user
|
||||
requests that the calendar be deleted.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_CALENDAR_ATTRIBUTE_UPDATED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever a
|
||||
calendar attribute is updated.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_ENTRY_ADDED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever an entry
|
||||
is added to the calendar.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_ENTRY_DELETED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever an entry
|
||||
is deleted from the calendar.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_ENTRY_UPDATED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever an entry
|
||||
is updated on the calendar.
|
||||
It is implementation specific
|
||||
if the callback function is invoked before or after the
|
||||
specified update type occurs.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Call Callbacks 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>Call Callbacks 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_call_callbacks</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_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_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.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.read.next.reminder;, &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-->
|
||||
190
cde/doc/C/guides/man/m3_csa/del_cale.sgm
Normal file
190
cde/doc/C/guides/man/m3_csa/del_cale.sgm
Normal file
@@ -0,0 +1,190 @@
|
||||
<!-- $XConsortium: del_cale.sgm /main/4 1996/08/30 15:33:34 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.MAN55.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_delete_calendar</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_delete_calendar</Function></RefName>
|
||||
<RefPurpose>delete a calendar from the calendar service
|
||||
</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_delete_calendar</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>delete_calendar_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_delete_calendar</Function> function deletes a calendar on the calendar service.
|
||||
Only
|
||||
the owner of the calendar, or a user with the owner
|
||||
authority, can remove the calendar from the calendar
|
||||
service.
|
||||
</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>Delete Calendar 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>Delete Calendar 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_delete_calendar</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_DISK_FULL</Term>
|
||||
<ListItem>
|
||||
<Para>Insufficient disk space was available to complete
|
||||
the requested operation (this may refer to local or shared disk space).
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_FUNCTION_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The function extension requested is invalid.
|
||||
</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_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_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.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.read.next.reminder;, &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-->
|
||||
255
cde/doc/C/guides/man/m3_csa/del_entr.sgm
Normal file
255
cde/doc/C/guides/man/m3_csa/del_entr.sgm
Normal file
@@ -0,0 +1,255 @@
|
||||
<!-- $XConsortium: del_entr.sgm /main/4 1996/08/30 15:33:58 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.MAN56.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_delete_entry</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_delete_entry</Function></RefName>
|
||||
<RefPurpose>delete an entry from a calendar
|
||||
</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_delete_entry</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_entry_handle <Parameter>entry</Parameter></ParamDef>
|
||||
<ParamDef>CSA_enum <Parameter>delete_scope</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>delete_entry_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_delete_entry</Function> function will delete an entry in a calendar.
|
||||
The
|
||||
delete_scope indicates the scope of the deletion if the
|
||||
entry has any associated recurring entries.
|
||||
All of the
|
||||
recurring entries can be deleted, only the specified entry
|
||||
can be deleted, or only the recurring entries that follow
|
||||
the specified entry can be deleted.
|
||||
Only the calendar
|
||||
owner, users with
|
||||
<SystemItem Class="Constant">CSA_OWNER_RIGHTS,</SystemItem> users with
|
||||
<SystemItem Class="Constant">CSA_UPDATE_PUBLIC_ENTRIES,</SystemItem> users with
|
||||
<SystemItem Class="Constant">CSA_UPDATE_CONFIDENTIAL_ENTRIES,</SystemItem> or users with
|
||||
<SystemItem Class="Constant">CSA_UPDATE_PRIVATE_ENTRIES</SystemItem> access rights can delete entries on the 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>Entry (Entry Handle)</Title>
|
||||
<Para>The handle of the calendar entry to be deleted.
|
||||
If the
|
||||
entry handle is invalid, then the error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_ENTRY_HANDLE</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Delete Scope (Enum)</Title>
|
||||
<Para>The scope for the delete operation.
|
||||
Operator settings
|
||||
include:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_SCOPE_ALL</Term>
|
||||
<ListItem>
|
||||
<Para>If set and the entry is associated with recurring entries,
|
||||
it specifies that all of the recurring entries are to be
|
||||
deleted.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_SCOPE_ONE</Term>
|
||||
<ListItem>
|
||||
<Para>If set and the entry is associated with recurring entries,
|
||||
it specifies that only the specified entry is to be
|
||||
deleted.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_SCOPE_FORWARD</Term>
|
||||
<ListItem>
|
||||
<Para>If set and the entry is associated with recurring entries,
|
||||
it specifies that only the recurring entries following the
|
||||
specified entry are to be deleted.
|
||||
The scope also includes
|
||||
the specified entry.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Delete Entry 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>Delete Entry 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_delete_entry</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_DISK_FULL</Term>
|
||||
<ListItem>
|
||||
<Para>Insufficient disk space was available to complete
|
||||
the requested operation (this may refer to local or shared disk space).
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_INVALID_ENTRY_HANDLE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid calendar entry handle was specified.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>A
|
||||
<StructName Role="typedef">CSA_enum</StructName> value is invalid.
|
||||
</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_SERVICE_UNAVAILABLE</Term>
|
||||
<ListItem>
|
||||
<Para>The requested calendar service is unavailable.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>The specified enumerated value is not valid.
|
||||
</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.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.read.next.reminder;, &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-->
|
||||
112
cde/doc/C/guides/man/m3_csa/free.sgm
Normal file
112
cde/doc/C/guides/man/m3_csa/free.sgm
Normal file
@@ -0,0 +1,112 @@
|
||||
<!-- $XConsortium: free.sgm /main/4 1996/08/30 15:34:31 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.MAN57.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_free</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_free</Function></RefName>
|
||||
<RefPurpose>free memory allocated by the calendaring service
|
||||
</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_free</Function></FuncDef>
|
||||
<ParamDef>CSA_buffer <Parameter>memory</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_free</Function> function frees memory allocated by the calendaring
|
||||
service.
|
||||
After the call, the pointer memory will be
|
||||
invalid and should not be referenced again.
|
||||
When any CSA
|
||||
function allocates and returns a buffer to the application,
|
||||
the application will free that memory with this call when
|
||||
it is finished with the memory.
|
||||
When a CSA function
|
||||
returns a base pointer to a complex structure containing
|
||||
several levels of pointers, all the application will do to
|
||||
free the entire structure or array of structures is call
|
||||
this routine with the base pointer returned by the CSA
|
||||
function.
|
||||
The CSA functions that return structures of
|
||||
this form are
|
||||
&cdeman.csa.list.calendars;, &cdeman.csa.look.up;, &cdeman.csa.query.configuration;, &cdeman.csa.list.calendar.attributes;, &cdeman.csa.read.calendar.attributes;, &cdeman.csa.free.time.search;, &cdeman.csa.add.entry;, &cdeman.csa.list.entries;, &cdeman.csa.list.entry.attributes;, &cdeman.csa.list.entry.sequence;, &cdeman.csa.read.entry.attributes;, and
|
||||
&cdeman.csa.read.next.reminder;, &cdeman.csa.update.entry.attributes;. The behavior of
|
||||
&cdeman.csa.free; is undefined when called with a pointer to a memory block
|
||||
not allocated by the calendaring service, a pointer to a
|
||||
memory block that has already been freed, or a pointer
|
||||
contained in a structure returned by the CSA
|
||||
implementation.
|
||||
In some situations, the extensions
|
||||
specified for a function may be a combination of input and
|
||||
output extensions.
|
||||
In this case, the memory returned in
|
||||
the output extensions must be freed one at a time using
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ARGUMENTS</Title>
|
||||
<RefSect2>
|
||||
<Title>Memory (Buffer)</Title>
|
||||
<Para>A pointer to memory allocated by the calendaring service.
|
||||
A value of
|
||||
<SystemItem Class="Constant">NULL</SystemItem> will be ignored, but will return the return code
|
||||
<SystemItem Class="Constant">CSA_SUCCESS</SystemItem>.</Para>
|
||||
</RefSect2>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Whether the function succeeded or not, and, if not, why.
|
||||
It may be success or one of the values listed under ERRORS
|
||||
below.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ERRORS</Title>
|
||||
<Para>The
|
||||
<Function>csa_free</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_INVALID_MEMORY</Term>
|
||||
<ListItem>
|
||||
<Para>A function parameter was invalid.
|
||||
</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.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.read.next.reminder;, &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-->
|
||||
277
cde/doc/C/guides/man/m3_csa/free_tim.sgm
Normal file
277
cde/doc/C/guides/man/m3_csa/free_tim.sgm
Normal file
@@ -0,0 +1,277 @@
|
||||
<!-- $XConsortium: free_tim.sgm /main/4 1996/08/30 15:34:51 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.MAN58.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_free_time_search</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_free_time_search</Function></RefName>
|
||||
<RefPurpose>searches one or more calendars for available free 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_free_time_search</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_date_time_range <Parameter>date_time_range</Parameter></ParamDef>
|
||||
<ParamDef>CSA_time_duration <Parameter>time_duration</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 <Parameter>number_users</Parameter></ParamDef>
|
||||
<ParamDef>CSA_calendar_user *<Parameter>calendar_users</Parameter></ParamDef>
|
||||
<ParamDef>CSA_free_time **<Parameter>free_time</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>free_time_search_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_free_time_search</Function> function searches for available free time on one or more
|
||||
calendars and returns a list of free time intervals found.
|
||||
Free time is an interval of time that is not currently
|
||||
scheduled on one or more calendars.
|
||||
The free time search
|
||||
is based on a date and time range and the minimum time
|
||||
duration required of the free time interval.
|
||||
Only the
|
||||
owner of the calendar, users with
|
||||
<SystemItem Class="Constant">CSA_FREE_TIME_SEARCH,</SystemItem> users with
|
||||
<SystemItem Class="Constant">CSA_VIEW_PUBLIC_ENTRIES,</SystemItem> users with
|
||||
<SystemItem Class="Constant">CSA_VIEW_CONFIDENTIAL_ENTRIES,</SystemItem> or users with
|
||||
<SystemItem Class="Constant">CSA_VIEW_PRIVATE_ENTRIES</SystemItem> can search the calendar for free time.
|
||||
</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>Date Time Range (Date Time Range)</Title>
|
||||
<Para>Specifies the start and stop date and time range for the
|
||||
free time search.
|
||||
If the date_time_range is invalid, then
|
||||
the error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_DATE_TIME</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Time Duration (Time Duration)</Title>
|
||||
<Para>Specifies the minimum time range for the free time
|
||||
intervals to be sought.
|
||||
If the time duration is invalid,
|
||||
then the error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_DATE_TIME</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Number Users (Uint32)</Title>
|
||||
<Para>The number of elements in the
|
||||
<Emphasis>calendar_users</Emphasis> argument.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Calendar Users (Calendar User)</Title>
|
||||
<Para>A pointer to an array of calendar users.
|
||||
This specifies
|
||||
the calendars to be searched for available free time.
|
||||
If
|
||||
the user does not have authority to access any of the
|
||||
attendee's calendars, then the error
|
||||
<SystemItem Class="Constant">CSA_E_NO_AUTHORITY</SystemItem> is returned.
|
||||
If an invalid attendee is specified, then the
|
||||
error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_USER</SystemItem> is returned.
|
||||
It is implementation specific whether the
|
||||
seach function will proceed in any of these cases.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Free Time Search 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>Free Time (Free Time)</Title>
|
||||
<Para>A pointer to a free time structure that specifies a set of
|
||||
free time intervals.
|
||||
If more free time intervals are found than can be
|
||||
represented in the available memory, the
|
||||
<SystemItem Class="Constant">CSA_E_INSUFFICIENT_MEMORY</SystemItem> error message will be returned.
|
||||
If no available free time
|
||||
is found, then a
|
||||
<SystemItem Class="Constant">NULL</SystemItem> pointer will be returned.
|
||||
This structure is allocated by
|
||||
the service, and should be freed with a single call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Free Time Search 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_free_time_search</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_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is invalid.
|
||||
</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_INVALID_USER</Term>
|
||||
<ListItem>
|
||||
<Para>The specified calendar user is invalid.
|
||||
</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_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is not supported.
|
||||
</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.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.read.next.reminder;, &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-->
|
||||
203
cde/doc/C/guides/man/m3_csa/list_caa.sgm
Normal file
203
cde/doc/C/guides/man/m3_csa/list_caa.sgm
Normal file
@@ -0,0 +1,203 @@
|
||||
<!-- $XConsortium: list_caa.sgm /main/4 1996/08/30 15:35:13 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.MAN59.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_list_calendar_attributes</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_list_calendar_attributes</Function></RefName>
|
||||
<RefPurpose>list the names of the calendar attributes associated with a calendar
|
||||
</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_list_calendar_attributes</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 *<Parameter>number_names</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute_reference **<Parameter>calendar_attributes_names</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>list_calendar_attributes_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_list_calendar_attributes</Function> function lists the names of the calendar attributes
|
||||
associated with a calendar.
|
||||
Using the returned calendar
|
||||
attribute name(s), the attribute value(s) may be read using
|
||||
the
|
||||
&cdeman.csa.read.calendar.attributes; function.
|
||||
Only the owner of the calendar, users with
|
||||
<SystemItem Class="Constant">CSA_OWNER_RIGHTS,</SystemItem> or users with
|
||||
<SystemItem Class="Constant">CSA_VIEW_CALENDAR_ATTRIBUTES</SystemItem> access rights can list the calendar attributes.
|
||||
</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>List Calendar Attributes 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 Names (Uint32)</Title>
|
||||
<Para>A pointer to the number of calendar attribute names
|
||||
returned in
|
||||
<Emphasis>calendar_attribute_names</Emphasis>.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Calendar Attribute Names (Attribute Reference)</Title>
|
||||
<Para>A pointer to an array of attribute names containing the
|
||||
names of the calendar attributes in the calendar.
|
||||
This
|
||||
array is allocated by the service, and should be freed with
|
||||
a single call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>List Calendar Attributes 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_list_calendar_attributes</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_FUNCTION_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The function extension requested is invalid.
|
||||
</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_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_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.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.read.next.reminder;, &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-->
|
||||
201
cde/doc/C/guides/man/m3_csa/list_cal.sgm
Normal file
201
cde/doc/C/guides/man/m3_csa/list_cal.sgm
Normal file
@@ -0,0 +1,201 @@
|
||||
<!-- $XConsortium: list_cal.sgm /main/4 1996/08/30 15:35:37 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.MAN60.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_list_calendars</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_list_calendars</Function></RefName>
|
||||
<RefPurpose>list the calendars supported by a calendar service
|
||||
</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_list_calendars</Function></FuncDef>
|
||||
<ParamDef>CSA_service_reference <Parameter>calendar_service</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 *<Parameter>number_names</Parameter></ParamDef>
|
||||
<ParamDef>CSA_calendar_user **<Parameter>calendar_names</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>list_calendars_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_list_calendars</Function> function lists all the calendars supported by the specified
|
||||
calendar service.
|
||||
The names of the calendars supported are
|
||||
returned in
|
||||
<Emphasis>calendar_names</Emphasis>, which is an array of
|
||||
<Literal>CSA_calendar_users</Literal> structures with
|
||||
<Emphasis>number_names</Emphasis> elements.
|
||||
It is implementation specific what authority a calendar
|
||||
user needs to invoke this function.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ARGUMENTS</Title>
|
||||
<RefSect2>
|
||||
<Title>Calendar Service (Service Reference)</Title>
|
||||
<Para>Specifies the calendar service.
|
||||
A
|
||||
<SystemItem Class="Constant">NULL</SystemItem> pointer will reference the default calendar service name.
|
||||
</Para>
|
||||
<Para>If the calendar service name is invalid, then the error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_CALENDAR_SERVICE</SystemItem> is returned.
|
||||
If the user is not sufficiently authorized to
|
||||
list the calendars on the calendar service, then the error
|
||||
<SystemItem Class="Constant">CSA_E_NO_AUTHORITY</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>List Calendars 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 Names (Uint32)</Title>
|
||||
<Para>A pointer to the number of calendar names returned in
|
||||
calendar_names.
|
||||
A value of zero indicates that no
|
||||
calendars are known to the calendar service.
|
||||
The error
|
||||
<SystemItem Class="Constant">CSA_E_INSUFFICIENT_MEMORY</SystemItem> is returned if the service has insufficient memory to store
|
||||
the complete set of requested information.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Calendar Names (Calendar User)</Title>
|
||||
<Para>A pointer to the array of calendar user structures,
|
||||
representing the calendars supported by the specified
|
||||
calendar service.
|
||||
This pointer is allocated by the
|
||||
service, and should be freed with a single call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>List Calendars 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 extension structure for more information.
|
||||
Indicates 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_list_calendars</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_CALENDAR_SERVICE</Term>
|
||||
<ListItem>
|
||||
<Para>The underlying calendar service is invalid, so logging on cannot be completed.
|
||||
</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_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_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.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.read.next.reminder;, &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-->
|
||||
200
cde/doc/C/guides/man/m3_csa/list_ena.sgm
Normal file
200
cde/doc/C/guides/man/m3_csa/list_ena.sgm
Normal file
@@ -0,0 +1,200 @@
|
||||
<!-- $XConsortium: list_ena.sgm /main/4 1996/08/30 15:36:07 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.MAN62.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_list_entry_attributes</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_list_entry_attributes</Function></RefName>
|
||||
<RefPurpose>list the names of the entry attributes associated with the specified entry
|
||||
</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_list_entry_attributes</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_entry_handle <Parameter>entry</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 *<Parameter>number_names</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute_reference **<Parameter>entry_attributes_names</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>list_entry_attributes_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_list_entry_attributes</Function> function lists the names of the entry attributes associated
|
||||
with a calendar entry.
|
||||
Using the returned entry attributes
|
||||
name(s), the attributes value(s) may be read using the
|
||||
&cdeman.csa.read.entry.attributes; function.
|
||||
</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>Entry (Entry Handle)</Title>
|
||||
<Para>Specifies the handle of the calendar entry that will have
|
||||
its attributes listed.
|
||||
If the entry handle is invalid,
|
||||
then the error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_ENTRY_HANDLE</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>List Entry Attributes 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 Names (Uint32)</Title>
|
||||
<Para>A pointer to the number of attribute names returned in
|
||||
<Emphasis>entry_attribute_names.</Emphasis></Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Entry Attribute Names (Attribute Reference)</Title>
|
||||
<Para>A pointer to an array of attribute references containing
|
||||
the names of the entry attributes in the calendar entry.
|
||||
This array is allocated by the service, and should be freed
|
||||
with a single call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>List Entry Attributes 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_list_entry_attributes</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_ENTRY_HANDLE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid calendar entry handle 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_SERVICE_UNAVAILABLE</Term>
|
||||
<ListItem>
|
||||
<Para>The requested calendar service is unavailable.
|
||||
</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.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.read.next.reminder;, &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-->
|
||||
234
cde/doc/C/guides/man/m3_csa/list_ens.sgm
Normal file
234
cde/doc/C/guides/man/m3_csa/list_ens.sgm
Normal file
@@ -0,0 +1,234 @@
|
||||
<!-- $XConsortium: list_ens.sgm /main/4 1996/08/30 15:36:22 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.MAN63.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_list_entry_sequence</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_list_entry_sequence</Function></RefName>
|
||||
<RefPurpose>lists the recurring calendar entries that are associated with a calendar entry
|
||||
</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_list_entry_sequence</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_entry_handle <Parameter>entry</Parameter></ParamDef>
|
||||
<ParamDef>CSA_date_time_range <Parameter>time_range</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 *<Parameter>number_entries</Parameter></ParamDef>
|
||||
<ParamDef>CSA_entry_handle **<Parameter>entry_list</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>list_entry_sequence_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_list_entry_sequence</Function> function returns an array of the entry handles for the
|
||||
recurring entries associated with a specific calendar
|
||||
entry.
|
||||
</Para>
|
||||
<Para>The entry handles for the recurring calendar entries are
|
||||
returned in
|
||||
<Emphasis>entry_list.</Emphasis> A
|
||||
<SystemItem Class="Constant">NULL</SystemItem> is returned if no recurring entries are associated with
|
||||
this calendar entry.
|
||||
</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>Entry (Entry Handle)</Title>
|
||||
<Para>Specifies the handle of the calendar entry to be accessed
|
||||
for a list of associated recurring entries.
|
||||
If the entry
|
||||
handle is invalid, then the error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_ENTRY_HANDLE</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Time Range (Date Time Range)</Title>
|
||||
<Para>The date and time range to be used to filter or restrict
|
||||
the listing of the entry sequence.
|
||||
The date and time range
|
||||
specificies a begin and end date and time.
|
||||
If
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then all entries in the sequence will be returned.
|
||||
If the
|
||||
sequence is of an indefinite repitition, then the function
|
||||
will return implementation specific results.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>List Entry Sequence 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 Entries (Uint32)</Title>
|
||||
<Para>The number of calendar entry handles actually returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Entry List (Entry Handle)</Title>
|
||||
<Para>A pointer to an array of calendar entry handles that
|
||||
represent the recurring entries associated with the
|
||||
specified calendar entry.
|
||||
This array is allocated by the
|
||||
service, and the entire array should be freed with a single
|
||||
call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>List Entry Sequence 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_list_entry_sequence</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_DATE_TIME</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid date and time combination was specified.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_ENTRY_HANDLE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid calendar entry handle 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_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_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.logoff;, &cdeman.csa.logon;, &cdeman.csa.look.up;, &cdeman.csa.query.configuration;, &cdeman.csa.read.calendar.attributes;, &cdeman.csa.read.entry.attributes;, &cdeman.csa.read.next.reminder;, &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-->
|
||||
365
cde/doc/C/guides/man/m3_csa/list_ent.sgm
Normal file
365
cde/doc/C/guides/man/m3_csa/list_ent.sgm
Normal file
@@ -0,0 +1,365 @@
|
||||
<!-- $XConsortium: list_ent.sgm /main/4 1996/08/30 15:36:32 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.MAN61.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_list_entries</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_list_entries</Function></RefName>
|
||||
<RefPurpose>list the calendar entries that match all the attribute search criteria
|
||||
</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_list_entries</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 <Parameter>number_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute *<Parameter>entry_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_enum *<Parameter>list_operators</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 *<Parameter>number_entries</Parameter></ParamDef>
|
||||
<ParamDef>CSA_entry_handle **<Parameter>entries</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>list_entries_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_list_entries</Function> function lists the entry handles for the calendar entries
|
||||
that match all the attribute search criteria.
|
||||
Using the
|
||||
returned entry handles, the entries can have their
|
||||
attributes listed and read, or the entries can updated or
|
||||
deleted.
|
||||
Only the calendar owner, users with
|
||||
<SystemItem Class="Constant">CSA_OWNER_RIGHTS,</SystemItem> users with
|
||||
<SystemItem Class="Constant">CSA_VIEW_PUBLIC_ENTRIES,</SystemItem> user with
|
||||
<SystemItem Class="Constant">CSA_VIEW_CONFIDENTIAL_ENTRIES,</SystemItem> or users with
|
||||
<SystemItem Class="Constant">CSA_VIEW_PRIVATE_ENTRIES</SystemItem> access rights can list entries in the calendar.
|
||||
If
|
||||
<Emphasis>list_operators</Emphasis> is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, this specifies a short hand for an array of operators of
|
||||
<SystemItem Class="Constant">CSA_MATCH_EQUAL_TO.</SystemItem> The criteria are specified by the array of attributes and
|
||||
the array of operators.
|
||||
Each operator in operators
|
||||
specifies how the corresponding attribute value is to be
|
||||
matched.
|
||||
The following operators are supported:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_ANY</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains the corresponding attribute
|
||||
regardless of the value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_NOT_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
not equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_GREATER_THAN</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
greater than the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_LESS_THAN</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
less than the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_GREATHER_THAN_OR_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
greater than or equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_LESS_THAN_OR_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
less than or equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_CONTAIN</Term>
|
||||
<ListItem>
|
||||
<Para>Applies to character string values only.
|
||||
It matches an
|
||||
entry that contains the corresponding substring value.
|
||||
The
|
||||
only operators supported for reminder type attributes are
|
||||
<SystemItem Class="Constant">CSA_MATCH_ANY</SystemItem> and
|
||||
<SystemItem Class="Constant">CSA_MATCH_EQUAL_TO.</SystemItem> Searching of attributes with opaque data type is not
|
||||
supported.
|
||||
It is implementation specific in what order the
|
||||
array of entries will be returned.
|
||||
If either
|
||||
<Emphasis>number_attributes</Emphasis> is zero or
|
||||
<Emphasis>entry_attributes</Emphasis> is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then all of the entries will be returned.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</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 Attributes (Uint32)</Title>
|
||||
<Para>Specifies the size of the arrays pointed to by
|
||||
<Emphasis>entry_attributes</Emphasis> and
|
||||
<Emphasis>list_operators</Emphasis>. If
|
||||
<Emphasis>entry_attributes</Emphasis> is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then this must be zero.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Entry Attributes (Attribute)</Title>
|
||||
<Para>A pointer to an array of attribute structures specifying
|
||||
the matching criteria.
|
||||
If
|
||||
<Emphasis>number_attributes</Emphasis> is zero, then this must be
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>List Operators (Enum)</Title>
|
||||
<Para>A pointer to an array of matching operators.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>List Entries 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 Entries (Uint32)</Title>
|
||||
<Para>The number of entry handles in entries.
|
||||
If this value is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then no entries were found to match the search criteria.
|
||||
If more entries were found than can be represented in the
|
||||
available memory, then the error
|
||||
<SystemItem Class="Constant">CSA_E_INSUFFICIENT_MEMORY</SystemItem> will be returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Entries (Entry Handle)</Title>
|
||||
<Para>A pointer to an array of entry handles that match all the
|
||||
search criteria.
|
||||
This array is allocated by the service
|
||||
and should be freed with a single call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>List Entries 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_list_entries</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_ATTRIBUTE_VALUE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid attribute value was specified for an attribute.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is invalid.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>A
|
||||
<StructName Role="typedef">CSA_enum</StructName> value is invalid.
|
||||
</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_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_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is not supported.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>The specified enumerated value is not valid.
|
||||
</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.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.read.next.reminder;, &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-->
|
||||
150
cde/doc/C/guides/man/m3_csa/logoff.sgm
Normal file
150
cde/doc/C/guides/man/m3_csa/logoff.sgm
Normal file
@@ -0,0 +1,150 @@
|
||||
<!-- $XConsortium: logoff.sgm /main/4 1996/08/30 15:36:49 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.MAN64.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_logoff</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_logoff</Function></RefName>
|
||||
<RefPurpose>terminate a session with a calendar
|
||||
</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_logoff</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>logoff_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_logoff</Function> function allows the calling application to terminate a
|
||||
session with 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>It becomes invalid as a result of this 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>Logoff 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>Logoff 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_logoff</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_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_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_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.logon;, &cdeman.csa.look.up;, &cdeman.csa.query.configuration;, &cdeman.csa.read.calendar.attributes;, &cdeman.csa.read.entry.attributes;, &cdeman.csa.read.next.reminder;, &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-->
|
||||
295
cde/doc/C/guides/man/m3_csa/logon.sgm
Normal file
295
cde/doc/C/guides/man/m3_csa/logon.sgm
Normal file
@@ -0,0 +1,295 @@
|
||||
<!-- $XConsortium: logon.sgm /main/4 1996/08/30 15:37:09 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.MAN65.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_logon</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_logon</Function></RefName>
|
||||
<RefPurpose>log on to the calendar service and establish a session with a calendar
|
||||
</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_logon</Function></FuncDef>
|
||||
<ParamDef>CSA_service_reference <Parameter>calendar_service</Parameter></ParamDef>
|
||||
<ParamDef>CSA_calendar_user *<Parameter>user</Parameter></ParamDef>
|
||||
<ParamDef>CSA_string <Parameter>password</Parameter></ParamDef>
|
||||
<ParamDef>CSA_string <Parameter>character_set</Parameter></ParamDef>
|
||||
<ParamDef>CSA_string <Parameter>required_csa_version</Parameter></ParamDef>
|
||||
<ParamDef>CSA_session_handle *<Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>logon_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_logon</Function> function allows the calling application to logon to the
|
||||
calendar service.
|
||||
If the specified calendar does not
|
||||
exist, then the error
|
||||
<SystemItem Class="Constant">CSA_E_CALENDAR_NOT_EXIST</SystemItem> is returned.
|
||||
</Para>
|
||||
<Para>The function returns a Session Handle that the application
|
||||
will use in subsequent CSA calls.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ARGUMENTS</Title>
|
||||
<RefSect2>
|
||||
<Title>Calendar Service (Service Reference)</Title>
|
||||
<Para>A calendar service name specifying the requested
|
||||
calendaring service, (e.g., the path to a calendar store or
|
||||
a remote server node name).
|
||||
This value may be
|
||||
<SystemItem Class="Constant">NULL</SystemItem> if the underlying calendaring service does not require a
|
||||
service name or if UI is allowed.
|
||||
This may be necessary on
|
||||
some implementations and ignored on others.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>User (Calendar User)</Title>
|
||||
<Para>A pointer to the calendar user structure that identifies
|
||||
the user and calendar to the calendaring service.
|
||||
This
|
||||
value may be
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Password (String)</Title>
|
||||
<Para>A string containing the password required for access to the
|
||||
CSA service.
|
||||
This value may be
|
||||
<SystemItem Class="Constant">NULL</SystemItem> if the underlying calendaring service does not require a
|
||||
password or if UI is allowed.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Character Set (String)</Title>
|
||||
<Para>A CSA formal public identifier string for the character set
|
||||
of strings used by the CSA caller.
|
||||
The client may pass
|
||||
<SystemItem Class="Constant">NULL</SystemItem> in which case the character set used is determined by the
|
||||
CSA service.
|
||||
The supported values are implementation
|
||||
specific.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Required CSA Version (String)</Title>
|
||||
<Para>The formal public identifier for the CSA version number
|
||||
required by the application.
|
||||
For this version of the
|
||||
specification this string must be
|
||||
``-//XAPIA/CSA/VERSION1/NONSGML CSA Version 1//EN''.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Logon Extensions (Extensions)</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>
|
||||
<Para>Through extensions, the application can find out which
|
||||
extensions are available and set which data extensions will
|
||||
be active for the session.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<RefSect2>
|
||||
<Title>Session (Session Handle)</Title>
|
||||
<Para>Opaque session handle that represents a session with the
|
||||
CSA calendar.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Logon Extensions (Extensions)</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_logon</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_CALENDAR_NOT_EXIST</Term>
|
||||
<ListItem>
|
||||
<Para>The specified calendar does not exist.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_CALENDAR_SERVICE</Term>
|
||||
<ListItem>
|
||||
<Para>The underlying calendar service is invalid, so logging on cannot be completed.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_CONFIGURATION</Term>
|
||||
<ListItem>
|
||||
<Para>The specified logon configuration is inconsistent with the
|
||||
selected calendar service.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is invalid.
|
||||
</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_PASSWORD</Term>
|
||||
<ListItem>
|
||||
<Para>The password is incorrect.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_USER</Term>
|
||||
<ListItem>
|
||||
<Para>The specified calendar user is invalid.
|
||||
</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_PASSWORD_REQUIRED</Term>
|
||||
<ListItem>
|
||||
<Para>A password is required on this calendar service.
|
||||
</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_TOO_MANY_USERS</Term>
|
||||
<ListItem>
|
||||
<Para>The implementation cannot support the additional logon of
|
||||
another calendar user at this time.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_CHARACTER_SET</Term>
|
||||
<ListItem>
|
||||
<Para>The character set requested is not supported.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension 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>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_VERSION</Term>
|
||||
<ListItem>
|
||||
<Para>The specification version specified in the call cannot be
|
||||
supported by this CSA implementation.
|
||||
</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.look.up;, &cdeman.csa.query.configuration;, &cdeman.csa.read.calendar.attributes;, &cdeman.csa.read.entry.attributes;, &cdeman.csa.read.next.reminder;, &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-->
|
||||
293
cde/doc/C/guides/man/m3_csa/look_up.sgm
Normal file
293
cde/doc/C/guides/man/m3_csa/look_up.sgm
Normal file
@@ -0,0 +1,293 @@
|
||||
<!-- $XConsortium: look_up.sgm /main/4 1996/08/30 15:37:32 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.MAN66.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_look_up</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_look_up</Function></RefName>
|
||||
<RefPurpose>Looks up calendar information
|
||||
</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_look_up</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_calendar_user *<Parameter>users</Parameter></ParamDef>
|
||||
<ParamDef>CSA_flags <Parameter>look_up_flags</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 *<Parameter>number_users</Parameter></ParamDef>
|
||||
<ParamDef>CSA_calendar_user **<Parameter>user_list</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>look_up_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_look_up</Function> function looks up calendar addressing information in the
|
||||
directory provided by the CSA calendaring service.
|
||||
It
|
||||
primarily is used to resolves a user's friendly name to a
|
||||
calendar address.
|
||||
</Para>
|
||||
<Para>Multiple addresses may be returned.
|
||||
An array of calendar
|
||||
user descriptors is allocated and returned containing fully
|
||||
resolved information about each entry.
|
||||
</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.
|
||||
</Para>
|
||||
<Para>If the session handle is invalid, then the error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_SESSION_HANDLE</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Users(Calendar User)</Title>
|
||||
<Para>A pointer to a calendar user structure containing the
|
||||
user-friendly names whose calendar address is to be looked
|
||||
up.
|
||||
For name resolution, the name field in the structure
|
||||
contains the user name to be resolved.
|
||||
The user type can
|
||||
be set to provide information on desired resolution of the
|
||||
name.
|
||||
See the calendar user structure documentation for possible types.
|
||||
For displaying calendar user details, the calendar
|
||||
user structure must contain an entry that resolves to only
|
||||
one user.
|
||||
If not, the error
|
||||
<SystemItem Class="Constant">CSA_E_AMBIGUOUS_USER</SystemItem> will be returned.
|
||||
For both name resolution and displaying
|
||||
user details, all user structures except the first will be
|
||||
ignored.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Look Up Flags (Flags)</Title>
|
||||
<Para>Bit mask of flags.
|
||||
Unspecified flags should always be
|
||||
passed as 0.
|
||||
Undocumented flags are reserved.
|
||||
Flag
|
||||
settings include:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_LOOKUP_RESOLVE_PREFIX_SEARCH</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the search method should be prefix.
|
||||
Prefix search
|
||||
means that all names matching the prefix string, beginning
|
||||
at the first character of the name, will be matched.
|
||||
If
|
||||
not set, the search method should be exact match.
|
||||
CSA
|
||||
implementations are required to support simple prefix
|
||||
searching.
|
||||
The availability of wild-card or substring
|
||||
searches is optional.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_LOOKUP_RESOLVE_IDENTITY</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the function will return a user record for the
|
||||
identity of the user in the calendar system.
|
||||
If this
|
||||
cannot be uniquely determined, ambiguous name resolution
|
||||
will be carried out.
|
||||
This allows the application to find
|
||||
out the address of the current user.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Look Up 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 Users (Uint32)</Title>
|
||||
<Para>A pointer to the number of elements
|
||||
<Emphasis>user_list.</Emphasis> If no names match the criteria, a value of zero is
|
||||
returned, and the error
|
||||
<SystemItem Class="Constant">CSA_E_USER_NOT_FOUND</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>User List (Calendar User)</Title>
|
||||
<Para>A pointer to an array of one or more calendar user
|
||||
structures allocated by
|
||||
&cdeman.csa.look.up;. The structure may then be used to fill in an attendee list
|
||||
structure.
|
||||
This pointer is allocated by the service, and
|
||||
should be freed with a single call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Look Up 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_look_up</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_AMBIGUOUS_USER</Term>
|
||||
<ListItem>
|
||||
<Para>The calendar user's name is ambiguous; multiple matches have been found.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is invalid.
|
||||
</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_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_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is not supported.
|
||||
</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>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_USER_NOT_FOUND</Term>
|
||||
<ListItem>
|
||||
<Para>One or more of the specified calendar users were not found.
|
||||
</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.query.configuration;, &cdeman.csa.read.calendar.attributes;, &cdeman.csa.read.entry.attributes;, &cdeman.csa.read.next.reminder;, &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-->
|
||||
368
cde/doc/C/guides/man/m3_csa/query_co.sgm
Normal file
368
cde/doc/C/guides/man/m3_csa/query_co.sgm
Normal file
@@ -0,0 +1,368 @@
|
||||
<!-- $XConsortium: query_co.sgm /main/4 1996/08/30 15:37:52 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.MAN67.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_query_configuration</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_query_configuration</Function></RefName>
|
||||
<RefPurpose>Determine information about the installed CSA configuration
|
||||
</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 <xcmc.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>CSA_return_code <Function>csa_query_configuration</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_enum <Parameter>item</Parameter></ParamDef>
|
||||
<ParamDef>CSA_buffer *<Parameter>reference</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>query_configuration_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_query_configuration</Function> function queries the underlying implementation's
|
||||
configuration, and returns the information requested about
|
||||
it, allocating memory when necessary.
|
||||
The underlying
|
||||
configuration file format is implementation dependent.
|
||||
</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.
|
||||
</Para>
|
||||
<Para>Session may be
|
||||
<SystemItem Class="Constant">NULL</SystemItem> to indicate that there is no session and that session
|
||||
independent information should be returned.
|
||||
This will
|
||||
provide default logon information.
|
||||
</Para>
|
||||
<Para>If this value is set to a valid Session Handle, session
|
||||
dependent configuration information will be returned.
|
||||
</Para>
|
||||
<Para>If the session handle is invalid, then the error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_SESSION_HANDLE</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Item (Enum)</Title>
|
||||
<Para>This argument indicates which configuration information
|
||||
should be returned.
|
||||
If the specified item is not
|
||||
appropriate for the implementation, the error
|
||||
<SystemItem Class="Constant">CSA_E_UNSUPPORTED_ENUM</SystemItem> is returned.
|
||||
The possible values include:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CONFIG_CHARACTER_SET</Term>
|
||||
<ListItem>
|
||||
<Para>The reference argument will be a pointer to the array of
|
||||
character set FPI strings for the implementation.
|
||||
The
|
||||
array will be terminated with a
|
||||
<SystemItem Class="Constant">NULL</SystemItem> string.
|
||||
The first character set FPI in the array is the
|
||||
default character set used if the caller does not specify
|
||||
one explicitly.
|
||||
This pointer to the array should be freed
|
||||
using
|
||||
&cdeman.csa.free;. This FPI is used by the caller at logon to specify to the
|
||||
implementation to use a different character set than the
|
||||
default.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CONFIG_LINE_TERM</Term>
|
||||
<ListItem>
|
||||
<Para>The reference argument will be a pointer to a
|
||||
<StructName Role="typedef">CSA_enum</StructName> variable, which will be set to a value of
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_LINE_TERM_CRLF</Term>
|
||||
<ListItem>
|
||||
<Para>if the line delimiter is a carriage return followed by a line feed,
|
||||
<SystemItem Class="Constant">CSA_LINE_TERM_LF</SystemItem> if the line delimiter is a line feed, or
|
||||
<SystemItem Class="Constant">CSA_LINE_TERM_CR</SystemItem> if the line delimiter is a carriage return.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CONFIG_DEFAULT_SERVICE</Term>
|
||||
<ListItem>
|
||||
<Para>The returned reference argument will be a pointer to a
|
||||
<StructName Role="typedef">CSA_string</StructName> into which the default service name will be returned.
|
||||
A pointer value of
|
||||
<SystemItem Class="Constant">NULL</SystemItem> will be written if no default service name is available.
|
||||
This pointer should be freed using
|
||||
&cdeman.csa.free;. This string, along with the one returned by
|
||||
<SystemItem Class="Constant">CSA_CONFIG_DEFAULT_USER,</SystemItem> can be used as defaults in user dialogs when asking for the
|
||||
service name, user name, and password.
|
||||
This will be
|
||||
returned in the implementation default character set.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CONFIG_DEFAULT_USER</Term>
|
||||
<ListItem>
|
||||
<Para>The reference argument will be a pointer to a
|
||||
<Literal>CSA_string,</Literal> into which the default user name will be returned.
|
||||
A
|
||||
pointer value of
|
||||
<SystemItem Class="Constant">NULL</SystemItem> will be written if no default user name is available.
|
||||
This
|
||||
pointer should be freed using
|
||||
&cdeman.csa.free;. This string, along with the one returned by
|
||||
<SystemItem Class="Constant">CSA_CONFIG_DEFAULT_SERVICE,</SystemItem> can be used as defaults in user dialogs when asking for the
|
||||
provider name, user name, and password.
|
||||
This will be
|
||||
returned in the implementation default character set.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CONFIG_REQ_PASSWORD</Term>
|
||||
<ListItem>
|
||||
<Para>The reference argument will be a pointer to a
|
||||
<StructName Role="typedef">CSA_enum</StructName> variable, which will be set to a value of
|
||||
<SystemItem Class="Constant">CSA_REQUIRED_NO</SystemItem> if the password is not required to logon,
|
||||
<SystemItem Class="Constant">CSA_REQUIRED_OPT</SystemItem> if the password is optional to logon, or
|
||||
<SystemItem Class="Constant">CSA_REQUIRED_YES</SystemItem> if the password is required to logon.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CONFIG_REQ_SERVICE</Term>
|
||||
<ListItem>
|
||||
<Para>The reference argument will be a pointer to a
|
||||
<StructName Role="typedef">CSA_enum</StructName> variable, which will be set to a value of
|
||||
<SystemItem Class="Constant">CSA_REQUIRED_NO</SystemItem> if the service name is not required to logon,
|
||||
<SystemItem Class="Constant">CSA_REQUIRED_OPT</SystemItem> if the service name is optional to logon, or
|
||||
<SystemItem Class="Constant">CSA_REQUIRED_YES</SystemItem> if the service name is required to logon.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CONFIG_REQ_USER</Term>
|
||||
<ListItem>
|
||||
<Para>The reference argument will be a pointer to a
|
||||
<StructName Role="typedef">CSA_enum</StructName> variable, which will be set to a value of
|
||||
<SystemItem Class="Constant">CSA_REQUIRED_NO</SystemItem> if the user name is not required to logon,
|
||||
<SystemItem Class="Constant">CSA_REQUIRED_OPT</SystemItem> if the user name is optional to logon, or
|
||||
<SystemItem Class="Constant">CSA_REQUIRED_YES</SystemItem> if the user name is required to logon.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CONFIG_UI_AVAIL</Term>
|
||||
<ListItem>
|
||||
<Para>The reference argument will be a pointer to a
|
||||
<StructName Role="typedef">CSA_boolean</StructName> variable, which will be set to a true value if there is UI
|
||||
provided by the CSA implementation.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CONFIG_VER_IMPLEM</Term>
|
||||
<ListItem>
|
||||
<Para>The reference argument will be a pointer to a
|
||||
<StructName Role="typedef">CSA_string</StructName> variable, which will be set to the CSA formal public
|
||||
identifier for the version number for the implementation.
|
||||
This pointer should be freed using
|
||||
&cdeman.csa.free;.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CONFIG_VER_SPEC</Term>
|
||||
<ListItem>
|
||||
<Para>The reference argument will be a pointer to a
|
||||
<StructName Role="typedef">CSA_string</StructName> variable, which will be set to the CSA formal public
|
||||
identifier for the CSA specification version number
|
||||
supported by this implementation.
|
||||
This pointer should be
|
||||
freed using
|
||||
&cdeman.csa.free;.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>The error
|
||||
<SystemItem Class="Constant">CSA_E_UNSUPPORTED_ENUM</SystemItem> is returned if the specified value is not supported by the
|
||||
implementation.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Query Configuration 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>
|
||||
<Para>Through extensions, the application can find out which
|
||||
extensions are available.
|
||||
The extension to do this is
|
||||
<SystemItem Class="Constant">CSA_X_COM_SUPPORT_EXT.</SystemItem> Any CSA implementation that supports extensions must
|
||||
support this extension.
|
||||
For more information on this
|
||||
extension, see the common extensions section of the
|
||||
extensions appendix in this document
|
||||
</Para>
|
||||
</RefSect2>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<RefSect2>
|
||||
<Title>Reference (Buffer)</Title>
|
||||
<Para>This argument points to the buffer in which to receive the
|
||||
configuration information.
|
||||
The type of the variable or
|
||||
buffer depends on the item argument.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Query Configuration 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_query_configuration</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_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>A
|
||||
<StructName Role="typedef">CSA_enum</StructName> value is invalid.
|
||||
</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_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_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>The specified enumerated value is not valid.
|
||||
</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.read.calendar.attributes;, &cdeman.csa.read.entry.attributes;, &cdeman.csa.read.next.reminder;, &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-->
|
||||
243
cde/doc/C/guides/man/m3_csa/read_cal.sgm
Normal file
243
cde/doc/C/guides/man/m3_csa/read_cal.sgm
Normal file
@@ -0,0 +1,243 @@
|
||||
<!-- $XConsortium: read_cal.sgm /main/5 1996/08/30 15:38:11 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.MAN68.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_read_calendar_attributes</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_read_calendar_attributes</Function></RefName>
|
||||
<RefPurpose>read and return the calendar attributes values for a calendar
|
||||
</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_calendar_attributes</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 <Parameter>number_names</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute_reference *<Parameter>attribute_names</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 *<Parameter>number_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute **<Parameter>calendar_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>read_calendar_attributes_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_read_calendar_attributes</Function> function returns an array of attributes structures
|
||||
containing the values of the calendar attributes of the
|
||||
specified calendar.
|
||||
The function will return all of the
|
||||
attributes if
|
||||
<Emphasis>number_names</Emphasis> argument is zero and
|
||||
<Emphasis>attribute_names</Emphasis> argument is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>. Only the owner of the calendar, users with
|
||||
<SystemItem Class="Constant">CSA_OWNER_RIGHTS,</SystemItem> or users with
|
||||
<SystemItem Class="Constant">CSA_VIEW_CALENDAR_ATTRIBUTES</SystemItem> access rights can read the calendar atttributes.
|
||||
</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>The number of calendar attribute names in
|
||||
<Emphasis>attribute_names.</Emphasis> If zero, then all of the attributes will be returned.
|
||||
If
|
||||
the
|
||||
<Emphasis>attribute_names</Emphasis> argument is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then this must be zero.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Attribute Names (Attribute Names)</Title>
|
||||
<Para>A pointer to an array of attribute names that are to be
|
||||
read.
|
||||
If
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then all of the attributes will be returned.
|
||||
If the
|
||||
<Emphasis>number_names</Emphasis> argument is zero, then this must be
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Read Calendar Attributes 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 Attributes (Uint32)</Title>
|
||||
<Para>A pointer to the number of attributes returned in
|
||||
calendar_attributes.
|
||||
The error
|
||||
<SystemItem Class="Constant">CSA_E_INSUFFICIENT_MEMORY</SystemItem> is returned if there is the service has insufficient memory
|
||||
to store the complete set of requested information.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Calendar Attributes (Attribute)</Title>
|
||||
<Para>A pointer to an array of attribute structures containing
|
||||
the values for the calendar attributes for the specified
|
||||
calendar.
|
||||
This array is allocated by the service, and
|
||||
should be freed with a single call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Read Calendar Attributes 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_calendar_attributes</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_FLAG</Term>
|
||||
<ListItem>
|
||||
<Para></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.entry.attributes;, &cdeman.csa.read.next.reminder;, &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-->
|
||||
237
cde/doc/C/guides/man/m3_csa/read_ent.sgm
Normal file
237
cde/doc/C/guides/man/m3_csa/read_ent.sgm
Normal file
@@ -0,0 +1,237 @@
|
||||
<!-- $XConsortium: read_ent.sgm /main/4 1996/08/30 15:38:29 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.MAN69.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_read_entry_attributes</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_read_entry_attributes</Function></RefName>
|
||||
<RefPurpose>read and return the calendar entry attribute values for a specified calendar entry
|
||||
</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_entry_attributes</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_entry_handle <Parameter>entry</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 <Parameter>number_names</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute_reference *<Parameter>attribute_names</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 *<Parameter>number_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute **<Parameter>entry_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>read_entry_attributes_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_read_entry_attributes</Function> function returns an array of attribute structures
|
||||
containing the values of the attributes of the specified
|
||||
calendar entry.
|
||||
The function will return all of the
|
||||
attributes if
|
||||
<Emphasis>number_names</Emphasis> argument is zero and
|
||||
<Emphasis>attribute_names</Emphasis> argument is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</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>Entry (Entry Handle)</Title>
|
||||
<Para>The handle of the calendar entry to be read.
|
||||
If the entry
|
||||
handle is invalid, then the error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_ENTRY_HANDLE</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Number Names (Uint32)</Title>
|
||||
<Para>The number of names in
|
||||
<Emphasis>attribute_names.</Emphasis> If
|
||||
<Emphasis>attribute_names</Emphasis> argument is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then this must be zero.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Attribute Names (Attribute Reference)</Title>
|
||||
<Para>A pointer to an array of attribute names that reference the
|
||||
attributes that are to be read.
|
||||
If
|
||||
<Emphasis>number_names</Emphasis> argument is zero, then this must be
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Read EntryAttribute 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 Attributes (Uint32)</Title>
|
||||
<Para>The number of attributes returned in
|
||||
<Emphasis>entry_attributes.</Emphasis> If none of the specified attributes have values, a value of
|
||||
zero is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Entry Attributes (Attribute)</Title>
|
||||
<Para>A pointer to an array of attributes.
|
||||
This pointer is
|
||||
allocated by the service and should be freed with a single
|
||||
call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Read Entry Attribute 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_entry_attributes</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_ENTRY_HANDLE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid calendar entry handle 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_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.next.reminder;, &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-->
|
||||
259
cde/doc/C/guides/man/m3_csa/read_nex.sgm
Normal file
259
cde/doc/C/guides/man/m3_csa/read_nex.sgm
Normal file
@@ -0,0 +1,259 @@
|
||||
<!-- $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-->
|
||||
270
cde/doc/C/guides/man/m3_csa/register.sgm
Normal file
270
cde/doc/C/guides/man/m3_csa/register.sgm
Normal file
@@ -0,0 +1,270 @@
|
||||
<!-- $XConsortium: register.sgm /main/4 1996/08/30 15:39:06 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.MAN71.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_register_callback</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_register_callback</Function></RefName>
|
||||
<RefPurpose>register the callback functions to be invoked when the specified type of update occurs in the calendar
|
||||
</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_register_callback</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_flags <Parameter>reason</Parameter></ParamDef>
|
||||
<ParamDef>CSA_callback <Parameter>callback</Parameter></ParamDef>
|
||||
<ParamDef>CSA_buffer <Parameter>client_data</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>register_callback_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_register_callback</Function> function adds the callback procedure to the specified
|
||||
callback list for the session.
|
||||
The service maintains a set
|
||||
of callback lists, logically one list per callback activity
|
||||
type per session.
|
||||
The service reports changes to the state
|
||||
of the service or its calendars by invoking the appropriate
|
||||
callbacks in sequence when the client calls the
|
||||
csa_call_callbacks function or when the specified callback
|
||||
activity occurs.
|
||||
The callback is only active for the
|
||||
duration of the calendar session.
|
||||
</Para>
|
||||
<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>Reason (Flags)</Title>
|
||||
<Para>A bitmask of flags.
|
||||
Unspecified flags should always be
|
||||
passed as 0.
|
||||
Undocumented flags are reserved.
|
||||
Each flag
|
||||
corresponds to a callback activity and the specified
|
||||
procedure is added to the callback list for that activity
|
||||
type.
|
||||
Flag settings include:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_CALENDAR_LOGON</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked when a the
|
||||
calendar is accessed by a user.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_CALENDAR_DELETED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked when a user
|
||||
requests that the calendar be deleted.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_CALENDAR_ATTRIBUTE_UPDATED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever a
|
||||
calendar attribute is updated.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_ENTRY_ADDED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever an entry
|
||||
is added to the calendar.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_ENTRY_DELETED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever an entry
|
||||
is deleted from the calendar.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_ENTRY_UPDATED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever an entry
|
||||
is updated on the calendar.
|
||||
It is implementation specific
|
||||
if the callback function is invoked before or after the
|
||||
specified update type occurs.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Callback (Callback)</Title>
|
||||
<Para>Specifies the client procedure that should be called by the
|
||||
service to handle the callback activity.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Client Data (Opaque Data)</Title>
|
||||
<Para>A pointer to a data structure that will be passed to the
|
||||
callback function in its client_data argument.
|
||||
This can be
|
||||
used to pass client-specific data structure that will be
|
||||
needed by the callback function to perform the task.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Register Callback 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>Register Callback 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_register_callback</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_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_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.read.next.reminder;, <![ %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-->
|
||||
412
cde/doc/C/guides/man/m3_csa/restore.sgm
Normal file
412
cde/doc/C/guides/man/m3_csa/restore.sgm
Normal file
@@ -0,0 +1,412 @@
|
||||
<!-- $XConsortium: restore.sgm /main/4 1996/08/30 15:39:23 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.MAN72.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_restore</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_restore</Function></RefName>
|
||||
<RefPurpose>restores calendar entries from an archive file
|
||||
</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_restore</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_string <Parameter>archive_name</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 <Parameter>number_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute *<Parameter>attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_enum *<Parameter>operators</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>restore_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>This optional function is not implemented in the &str-XZ; 1.0 Sample Implementation.
|
||||
</Para>
|
||||
]]>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>The
|
||||
<Function>csa_restore</Function> function restores entries from the specified archive file
|
||||
into the calendar that is currently logged on to.
|
||||
Only
|
||||
calendar entries that match all the given criteria are
|
||||
restored.
|
||||
It is implementation specific whether new entry
|
||||
handles will be assigned to the entries restored.
|
||||
If
|
||||
attributes is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, all the entries in the archive file will be restored.
|
||||
If
|
||||
operators is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, this specifies a short hand for an array of operators of
|
||||
<SystemItem Class="Constant">CSA_MATCH_EQUAL_TO.</SystemItem> Only the owner of the calendar or users with
|
||||
<SystemItem Class="Constant">CSA_OWNER_RIGHTS</SystemItem> can restore an archive file.
|
||||
</Para>
|
||||
<Para>The matching criteria are specified by the array of
|
||||
attributes and the array of operators.
|
||||
Each operator in
|
||||
operators specifies how the corresponding attribute value
|
||||
is to be matched.
|
||||
The following operators are supported:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_ANY</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains the corresponding attribute
|
||||
regardless of the value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_NOT_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
not equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_GREATER_THAN</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
greater than the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_LESS_THAN</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
less than the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_GREATHER_THAN_OR_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
greater than or equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_LESS_THAN_OR_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
less than or equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_CONTAIN</Term>
|
||||
<ListItem>
|
||||
<Para>Applies to character string values only.
|
||||
It matches an
|
||||
entry that contains the corresponding substring value.
|
||||
The
|
||||
only operators supported for reminder type attributes are
|
||||
<SystemItem Class="Constant">CSA_MATCH_ANY</SystemItem> and
|
||||
<SystemItem Class="Constant">CSA_MATCH_EQUAL_TO.</SystemItem> Searching of attributes with opaque data type is not
|
||||
supported.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ARGUMENTS</Title>
|
||||
<RefSect2>
|
||||
<Title>Session (Session Handle)</Title>
|
||||
<Para>Opaque session handle that represents a session with the
|
||||
calendar service.
|
||||
</Para>
|
||||
<Para>Session handles are created by a logon function call and
|
||||
invalidate 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>Archive Name (String)</Title>
|
||||
<Para>A string containing the name of the archive file on the
|
||||
local system.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Number Attributes (Uint32)</Title>
|
||||
<Para>Specifies the size of the arrays pointed to by attributes
|
||||
and operators.
|
||||
If the attributes argument is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then this must be zero.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Attributes (Attribute)</Title>
|
||||
<Para>A pointer to an array of attribute structures specifying
|
||||
the matching criteria.
|
||||
If the
|
||||
<Emphasis>number_attributes</Emphasis> argument is zero, then this must be
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Operators (Enum)</Title>
|
||||
<Para>A pointer to an array of matching operator flags for the
|
||||
corresponding attribute in attributes.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Restore 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>Restore 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_restore</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_DISK_FULL</Term>
|
||||
<ListItem>
|
||||
<Para>Insufficient disk space was available to complete
|
||||
the requested operation (this may refer to local or shared disk space).
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_FILE_NOT_EXIST</Term>
|
||||
<ListItem>
|
||||
<Para>The specified file in
|
||||
<Emphasis>csa_restore</Emphasis> does not exist.
|
||||
</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_ATTRIBUTE_VALUE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid attribute value was specified for an attribute.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is invalid.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>A
|
||||
<StructName Role="typedef">CSA_enum</StructName> value is invalid.
|
||||
</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_FILE_NAME</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid file name was specified.
|
||||
</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_RULE</Term>
|
||||
<ListItem>
|
||||
<Para>The implementation does not understand the exception or recurrence rule.
|
||||
</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_TEXT_TOO_LARGE</Term>
|
||||
<ListItem>
|
||||
<Para>The size of the text string passed to the implementation is too large.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNABLE_TO_OPEN_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>Unable to open the specified file.
|
||||
</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_CHARACTER_SET</Term>
|
||||
<ListItem>
|
||||
<Para>The character set requested is not supported.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is not supported.
|
||||
</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>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_VERSION</Term>
|
||||
<ListItem>
|
||||
<Para>The specification version specified in the call cannot be
|
||||
supported by this CSA implementation.
|
||||
</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.read.next.reminder;, &cdeman.csa.register.callback;, &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-->
|
||||
398
cde/doc/C/guides/man/m3_csa/save.sgm
Normal file
398
cde/doc/C/guides/man/m3_csa/save.sgm
Normal file
@@ -0,0 +1,398 @@
|
||||
<!-- $XConsortium: save.sgm /main/4 1996/08/30 15:39:40 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.MAN73.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_save</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_save</Function></RefName>
|
||||
<RefPurpose>saves calendar entries into an archive file
|
||||
</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_save</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_string <Parameter>archive_name</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 <Parameter>number_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute *<Parameter>attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_enum *<Parameter>operators</Parameter></ParamDef>
|
||||
<ParamDef>CSA_boolean <Parameter>delete_entry</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>save_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>This optional function is not implemented in the &str-XZ; 1.0 Sample Implementation.
|
||||
</Para>
|
||||
]]>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>The
|
||||
<Function>csa_save</Function> function saves entries from the calendar that is currently
|
||||
logged on to into the specified archive file.
|
||||
Only
|
||||
calendar entries that match all the given criteria are
|
||||
saved.
|
||||
</Para>
|
||||
<Para>The entry handles for the entries are not guaranteed to be
|
||||
maintained.
|
||||
If attributes is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, all the entries in the calendar will be saved.
|
||||
If
|
||||
operators is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, this specifies a short hand for an array of operators of
|
||||
<SystemItem Class="Constant">CSA_MATCH_EQUAL_TO.</SystemItem> Only the owner of the calendar or users with
|
||||
<SystemItem Class="Constant">CSA_OWNER_RIGHTS</SystemItem> can save entries into an archive file.
|
||||
</Para>
|
||||
<Para>The matching criteria are specified by the array of
|
||||
attributes and the array of operators.
|
||||
Each operator in
|
||||
operators specifies how the corresponding attribute value
|
||||
is to be matched.
|
||||
The following operators are supported:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_ANY</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains the corresponding attribute
|
||||
regardless of the value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_NOT_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
not equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_GREATER_THAN</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
greater than the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_LESS_THAN</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
less than the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_GREATHER_THAN_OR_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
greater than or equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_LESS_THAN_OR_EQUAL_TO</Term>
|
||||
<ListItem>
|
||||
<Para>Matches an entry that contains an attribute with a value
|
||||
less than or equal to the corresponding value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_MATCH_CONTAIN</Term>
|
||||
<ListItem>
|
||||
<Para>Applies to character string values only.
|
||||
It matches an
|
||||
entry that contains the corresponding substring value.
|
||||
The
|
||||
only operators supported for reminder type attributes are
|
||||
<SystemItem Class="Constant">CSA_MATCH_ANY</SystemItem> and
|
||||
<SystemItem Class="Constant">CSA_MATCH_EQUAL_TO.</SystemItem> Searching of attributes with opaque data type is not
|
||||
supported.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ARGUMENTS</Title>
|
||||
<RefSect2>
|
||||
<Title>Session (Session Handle)</Title>
|
||||
<Para>Opaque session handle that represents a session with the
|
||||
calendar service.
|
||||
</Para>
|
||||
<Para>Session handles are created by a logon function call and
|
||||
invalidate 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>Archive Name (String)</Title>
|
||||
<Para>A string containing the name of the archive file on the
|
||||
local system.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Number Attributes (Uint32)</Title>
|
||||
<Para>Specifies the size of the arrays pointed to by attributes
|
||||
and operators.
|
||||
If attribute argument is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then this must be zero.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Attributes (Attribute)</Title>
|
||||
<Para>A pointer to an array of attribute structures specifying
|
||||
the matching criteria.
|
||||
If
|
||||
<Emphasis>number_attributes</Emphasis> argument is zero, then this must be
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Operators (Enum)</Title>
|
||||
<Para>A pointer to an array of matching operator flags for the
|
||||
corresponding attribute in attributes.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Delete Entry (Boolean)</Title>
|
||||
<Para>Specifies whether the associated entries are to be deleted
|
||||
from the calendar after being archived into the archive
|
||||
file.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Save 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>Save 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_save</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_DISK_FULL</Term>
|
||||
<ListItem>
|
||||
<Para>Insufficient disk space was available to complete
|
||||
the requested operation (this may refer to local or shared disk space).
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_FILE_EXIST</Term>
|
||||
<ListItem>
|
||||
<Para>The specified file in
|
||||
<Emphasis>csa_save</Emphasis> already exists.
|
||||
</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_ATTRIBUTE_VALUE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid attribute value was specified for an attribute.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is invalid.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>A
|
||||
<StructName Role="typedef">CSA_enum</StructName> value is invalid.
|
||||
</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_FILE_NAME</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid file name was specified.
|
||||
</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_TEXT_TOO_LARGE</Term>
|
||||
<ListItem>
|
||||
<Para>The size of the text string passed to the implementation is too large.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNABLE_TO_OPEN_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>Unable to open the specified file.
|
||||
</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_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is not supported.
|
||||
</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.read.next.reminder;, &cdeman.csa.register.callback;, &cdeman.csa.restore;, &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-->
|
||||
275
cde/doc/C/guides/man/m3_csa/unregist.sgm
Normal file
275
cde/doc/C/guides/man/m3_csa/unregist.sgm
Normal file
@@ -0,0 +1,275 @@
|
||||
<!-- $XConsortium: unregist.sgm /main/4 1996/08/30 15:39:57 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.MAN74.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_unregister_callback</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_unregister_callback</Function></RefName>
|
||||
<RefPurpose>unregister the specified callback functions
|
||||
</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_unregister_callback</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_flags <Parameter>reason</Parameter></ParamDef>
|
||||
<ParamDef>CSA_callback <Parameter>callback</Parameter></ParamDef>
|
||||
<ParamDef>CSA_buffer <Parameter>client_data</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>unregister_callback_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_unregister_callback</Function> function removes the specified callback procedure to the
|
||||
specified callback list.
|
||||
Both the procedure and the client
|
||||
data must match for this function to remove the procedure.
|
||||
Specifying a value of
|
||||
<SystemItem Class="Constant">NULL</SystemItem> for both callback and client data will cause all callbacks
|
||||
on the specified callback list(s) to be removed.
|
||||
</Para>
|
||||
<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>Reason (Flags)</Title>
|
||||
<Para>A bitmask of flags.
|
||||
Unspecified flags should always be
|
||||
passed as 0.
|
||||
Undocumented flags are reserved.
|
||||
Each flag
|
||||
corresponds to a callback list.
|
||||
Flag settings include:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_CALENDAR_LOGON</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked when a the
|
||||
calendar is accessed by a user.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_CALENDAR_DELETED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked when a user
|
||||
requests that the calendar be deleted.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_CALENDAR_ATTRIBUTE_UPDATED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever a
|
||||
calendar attribute is updated.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_ENTRY_ADDED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever an entry
|
||||
is added to the calendar.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_ENTRY_DELETED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever an entry
|
||||
is deleted from the calendar.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_CB_ENTRY_UPDATED</Term>
|
||||
<ListItem>
|
||||
<Para>If set, the new callback will be invoked whenever an entry
|
||||
is updated on the calendar.
|
||||
It is implementation specific
|
||||
if the callback function is invoked before or after the
|
||||
specified update type occurs.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Callback (Callback)</Title>
|
||||
<Para>Specifies the client procedure that should be removed from
|
||||
the specified callback list(s).
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Client Data (Opaque Data)</Title>
|
||||
<Para>A pointer to an application specific data structure that
|
||||
was specified when the callback procedure was registered.
|
||||
This must match for the function to succeed.
|
||||
This
|
||||
constraint allows the application to register the same
|
||||
function on more than one callback list with different
|
||||
client_data.
|
||||
The instances of the callback function on the
|
||||
different callback lists will be treated independently by
|
||||
the calendar service.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Unregister Callback 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>Unregister Callback 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_unregister_callback</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_CALLBACK_NOT_REGISTERED</Term>
|
||||
<ListItem>
|
||||
<Para>The specified callback function was not registered.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_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_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.read.next.reminder;, &cdeman.csa.register.callback;, <![ %CDE.C.XO; [&cdeman.csa.restore;, &cdeman.csa.save;, ]]>&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-->
|
||||
266
cde/doc/C/guides/man/m3_csa/update_c.sgm
Normal file
266
cde/doc/C/guides/man/m3_csa/update_c.sgm
Normal file
@@ -0,0 +1,266 @@
|
||||
<!-- $XConsortium: update_c.sgm /main/4 1996/08/30 15:40:15 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.MAN75.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_update_calendar_attributes</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_update_calendar_attributes</Function></RefName>
|
||||
<RefPurpose>update the calendar attributes values for a calendar
|
||||
</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_update_calendar_attributes</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 <Parameter>number_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute *<Parameter>calendar_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>update_calendar_attributes_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_update_calendar_attributes</Function> function update the values of the calendar attributes of
|
||||
the specified calendar.
|
||||
The existing value of each
|
||||
specified attribute will be replaced by the new value
|
||||
specified in
|
||||
<Emphasis>calendar_attributes</Emphasis>. New attributes can be
|
||||
added using this function and existing attributes can be
|
||||
effectively deleted by setting the value part of the
|
||||
<Literal>CSA_attributes</Literal> structure to
|
||||
<SystemItem Class="Constant">NULL</SystemItem>. If a read-only attribute is specified, the error
|
||||
<SystemItem Class="Constant">CSA_E_READ_ONLY</SystemItem> is returned by the function.
|
||||
If the function returns an
|
||||
error, none of the specified attributes will be updated.
|
||||
Only the owner of the calendar, users with
|
||||
<SystemItem Class="Constant">CSA_OWNER_RIGHTS,</SystemItem> users with
|
||||
<SystemItem Class="Constant">CSA_INSERT_CALENDAR_ATTRIBUTES</SystemItem> access rights, or users with
|
||||
<SystemItem Class="Constant">CSA_UPDATE_CALENDAR_ATTRIBUTES,</SystemItem> can update the calendar attributes.
|
||||
</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 Attributes (Uint32)</Title>
|
||||
<Para>The number of calendar attributes in
|
||||
<Emphasis>calendar_attributes</Emphasis>.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Calendar Attributes (Attribute)</Title>
|
||||
<Para>A pointer to an array of attribute structures containing
|
||||
the new values for the calendar attributes.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Update Calendar Attributes 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>Update Calendar Attributes 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_update_calendar_attributes</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_DISK_FULL</Term>
|
||||
<ListItem>
|
||||
<Para>Insufficient disk space was available to complete
|
||||
the requested operation (this may refer to local or shared disk space).
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_ATTRIBUTE_VALUE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid attribute value was specified for an attribute.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is invalid.
|
||||
</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_READ_ONLY</Term>
|
||||
<ListItem>
|
||||
<Para>An attempt was made to update a readonly attribute.
|
||||
</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_TEXT_TOO_LARGE</Term>
|
||||
<ListItem>
|
||||
<Para>The size of the text string passed to the implementation is too large.
|
||||
</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_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is not supported.
|
||||
</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.read.next.reminder;, &cdeman.csa.register.callback;, <![ %CDE.C.XO; [&cdeman.csa.restore;, &cdeman.csa.save;, ]]>&cdeman.csa.unregister.callback;, &cdeman.csa.update.entry.attributes;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
|
||||
368
cde/doc/C/guides/man/m3_csa/update_e.sgm
Normal file
368
cde/doc/C/guides/man/m3_csa/update_e.sgm
Normal file
@@ -0,0 +1,368 @@
|
||||
<!-- $XConsortium: update_e.sgm /main/4 1996/08/30 15:40:32 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.MAN76.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_update_entry_attributes</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_update_entry_attributes</Function></RefName>
|
||||
<RefPurpose>update the calendar entry attributes
|
||||
</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_update_entry_attributes</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>session</Parameter></ParamDef>
|
||||
<ParamDef>CSA_entry_handle <Parameter>entry</Parameter></ParamDef>
|
||||
<ParamDef>CSA_enum <Parameter>update_scope</Parameter></ParamDef>
|
||||
<ParamDef>CSA_boolean <Parameter>update_propagation</Parameter></ParamDef>
|
||||
<ParamDef>CSA_uint32 <Parameter>number_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_attribute *<Parameter>entry_attributes</Parameter></ParamDef>
|
||||
<ParamDef>CSA_entry_handle *<Parameter>new_entry</Parameter></ParamDef>
|
||||
<ParamDef>CSA_extension *<Parameter>update_entry_attributes_extensions</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_update_entry_attributes</Function> function updates the values of the entry attributes of the
|
||||
specified calendar entry.
|
||||
The existing value of each
|
||||
specified attribute will be replaced by the new value
|
||||
specified in
|
||||
<Emphasis>entry_attributes.</Emphasis> New attributes can be added using this function and
|
||||
existing attributes can be effectively deleted by setting
|
||||
the value part of the
|
||||
<Emphasis>entry_attributes</Emphasis> structure to
|
||||
<SystemItem Class="Constant">NULL</SystemItem>. If a read-only attribute is specified, the error
|
||||
<SystemItem Class="Constant">CSA_E_READONLY</SystemItem> will be returned.
|
||||
If the function returns an error, none
|
||||
of the specified attributes will be updated.
|
||||
Only the
|
||||
owner of the calendar, or users with
|
||||
<SystemItem Class="Constant">CSA_OWNER_RIGHTS,</SystemItem> users with
|
||||
<SystemItem Class="Constant">CSA_CHANGE_PUBLIC_ENTRIES,</SystemItem> users with
|
||||
<SystemItem Class="Constant">CSA_CHANGE_CONFIDENTIAL_ENTRIES,</SystemItem> or users with
|
||||
<SystemItem Class="Constant">CSA_CHANGE_PRIVATE_ENTRIES</SystemItem> can update the entry attributes.
|
||||
</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>Entry (Entry Handle)</Title>
|
||||
<Para>The handle of the calendar entry to be updated.
|
||||
If the
|
||||
entry handle is invalid, then the error
|
||||
<SystemItem Class="Constant">CSA_E_INVALID_ENTRY_HANDLE</SystemItem> is returned.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Update Scope (Enum)</Title>
|
||||
<Para>Specifies the scope of the entry update.
|
||||
The value is one
|
||||
of:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_SCOPE_ALL</Term>
|
||||
<ListItem>
|
||||
<Para>Specifies that the scope of the update is for all recurring
|
||||
entries associated with the specified entry:
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_SCOPE_ONE</Term>
|
||||
<ListItem>
|
||||
<Para>Specifies that the scope of the update is for just the
|
||||
specified entry.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_SCOPE_FORWARD</Term>
|
||||
<ListItem>
|
||||
<Para>Specifies that the scope of the update is for those
|
||||
recurring entries subsequent to the specified entry.
|
||||
The
|
||||
scope also includes the specified entry.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Update Propagation (Boolean)</Title>
|
||||
<Para>The update propagation flag.
|
||||
A value of FALSE indicates
|
||||
that the calendar service is not to propagate updates to
|
||||
the entry to the attendees' calendars.
|
||||
A value of TRUE
|
||||
indicates that the calendar service is to attempt to
|
||||
propagate updates to the entry to the attendees'
|
||||
calendars.
|
||||
Propagation of updates is an implementation
|
||||
specific feature.
|
||||
Implementations that do not support
|
||||
update propagation will return the error
|
||||
<SystemItem Class="Constant">CSA_E_UNSUPPORTED_PARAMETER</SystemItem> if a value other than FALSE is specified.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Number Attributes (Uint32)</Title>
|
||||
<Para>The number of attributes that will be used to define the
|
||||
entry updates.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Entry Attributes (Attribute)</Title>
|
||||
<Para>A pointer to an array of attributes that will be used to
|
||||
define the entry updates.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Update Entry Attributes 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>New Entry (Entry Handle)</Title>
|
||||
<Para>A pointer to the handle of the updated calendar entry.
|
||||
If
|
||||
this value is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then the implementation did not need to create a new entry
|
||||
handle for the updated entry.
|
||||
This handle is allocated by
|
||||
the service and should be freed with a single call to
|
||||
&cdeman.csa.free;.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Update Entry Attributes 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_update_entry_attributes</Function> function returns the following error values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_DISK_FULL</Term>
|
||||
<ListItem>
|
||||
<Para>Insufficient disk space was available to complete
|
||||
the requested operation (this may refer to local or shared disk space).
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<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_ATTRIBUTE_VALUE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid attribute value was specified for an attribute.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is invalid.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_ENTRY_HANDLE</Term>
|
||||
<ListItem>
|
||||
<Para>An invalid calendar entry handle was specified.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_INVALID_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>A
|
||||
<StructName Role="typedef">CSA_enum</StructName> value is invalid.
|
||||
</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_READ_ONLY</Term>
|
||||
<ListItem>
|
||||
<Para>An attempt was made to update a readonly attribute.
|
||||
</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_TEXT_TOO_LARGE</Term>
|
||||
<ListItem>
|
||||
<Para>The size of the text string passed to the implementation is too large.
|
||||
</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_DATA_EXT</Term>
|
||||
<ListItem>
|
||||
<Para>The data extension requested is not supported.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_ENUM</Term>
|
||||
<ListItem>
|
||||
<Para>The specified enumerated value is not valid.
|
||||
</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.
|
||||
The specified function extension is not supported or
|
||||
<SystemItem Class="Constant">CSA_EXT_REQUIRED</SystemItem> is set.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>CSA_E_UNSUPPORTED_PARAMETER</Term>
|
||||
<ListItem>
|
||||
<Para>One of the parameters is not supported.
|
||||
</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.read.next.reminder;, &cdeman.csa.register.callback;, <![ %CDE.C.XO; [&cdeman.csa.restore;, &cdeman.csa.save;, ]]>&cdeman.csa.unregister.callback;, &cdeman.csa.update.calendar.attributes;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
|
||||
93
cde/doc/C/guides/man/m3_csa/x_proces.sgm
Normal file
93
cde/doc/C/guides/man/m3_csa/x_proces.sgm
Normal file
@@ -0,0 +1,93 @@
|
||||
<!-- $XConsortium: x_proces.sgm /main/5 1996/08/30 15:40:49 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. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN72.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN72.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>csa_x_process_updates</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>csa_x_process_updates</Function></RefName>
|
||||
<RefPurpose>invoke a calendar application's calendar event handler
|
||||
</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.-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <csa/csa.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>csa_x_process_updates</Function></FuncDef>
|
||||
<ParamDef>CSA_session_handle <Parameter>cal</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>csa_x_process_updates</Function> function checks to see if there have been calendar updates
|
||||
that are of interest to the client.
|
||||
If there have been one
|
||||
or more calendar updates, and the client previously
|
||||
registered a callback handler using
|
||||
&cdeman.csa.register.callback; for updates of this type, the callback function is called by
|
||||
<Function>csa_x_process_updates</Function>.</Para>
|
||||
<Para>The
|
||||
<Emphasis>cal</Emphasis> argument specifies a calendar session handle.
|
||||
The callback
|
||||
function will be invoked only if there have been updates to
|
||||
this calendar.
|
||||
If
|
||||
<Emphasis>cal</Emphasis> is set to
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, the callback function will be invoked if there have been
|
||||
updates to any logged on calendars.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>csa_x_process_updates</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The
|
||||
<Function>csa_x_process_updates</Function> function is useful for applications that maintain a
|
||||
dynamic representation of calendar information, such as a
|
||||
GUI calendar display.
|
||||
Because the calendar server can
|
||||
simultaneously maintain multiple read/write connections for
|
||||
the same calendar, any data retrieved by a client should be
|
||||
considered immediately out of date.
|
||||
To create the
|
||||
appearance of a dynamic display of calendar data, such an
|
||||
application should call
|
||||
<Function>csa_x_process_updates</Function> as frequently as necessary from within its main event loop.
|
||||
</Para>
|
||||
<Para>One way to do this is to have a timeout handler call
|
||||
<Function>csa_x_process_updates</Function> at regular intervals.
|
||||
The duration of the timer should be
|
||||
appropriate for the expected user environment.
|
||||
This does
|
||||
not eliminate the risk of the client holding outdated
|
||||
information;
|
||||
it merely gives the application control over
|
||||
how old the information can get.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.csa.csa.h;, <![ %CDE.C.CDE; [&cdeman.csa.register.callback;. ]]><![ %CDE.C.XO; [<Function>csa_register_callback</Function> in the &str-Za;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
Reference in New Issue
Block a user