debian/cdesktop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
16e67fec810f4fffe796ccfe246dc0246ac4e7fc
cdesktop/cde/doc/C/guides/man/m3_csa/update_e.sgm

369 lines
12 KiB
Plaintext
Raw Blame History

<!-- $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 &lt;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-->
Reference in New Issue View Git Blame Copy Permalink