You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@vcl.apache.org by jf...@apache.org on 2009/06/09 17:03:21 UTC
svn commit: r783024 [1/2] - in /incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs:
doxygen.css examples.html files.html globals.html globals_func.html
index.html tabs.css xmlrpcWrappers_8php.html
xmlrpc__example_8php-example.html
Author: jfthomps
Date: Tue Jun 9 15:03:21 2009
New Revision: 783024
URL: http://svn.apache.org/viewvc?rev=783024&view=rev
Log:
regenerated these docs from the source code using doxygen and the doxyfile.xmlrpc config file
Modified:
incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/doxygen.css
incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/examples.html
incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/files.html
incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/globals.html
incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/globals_func.html
incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/index.html
incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/tabs.css
incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/xmlrpcWrappers_8php.html
incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/xmlrpc__example_8php-example.html
Modified: incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/doxygen.css
URL: http://svn.apache.org/viewvc/incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/doxygen.css?rev=783024&r1=783023&r2=783024&view=diff
==============================================================================
--- incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/doxygen.css (original)
+++ incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/doxygen.css Tue Jun 9 15:03:21 2009
@@ -1,36 +1,22 @@
-/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {
font-family: Geneva, Arial, Helvetica, sans-serif;
}
BODY,TD {
- font-size: 90%;
+ font-size: 90%;
}
H1 {
text-align: center;
- font-size: 160%;
+ font-size: 160%;
}
H2 {
- font-size: 120%;
+ font-size: 120%;
}
H3 {
- font-size: 100%;
+ font-size: 100%;
+}
+CAPTION {
+ font-weight: bold
}
-CAPTION { font-weight: bold }
DIV.qindex {
width: 100%;
background-color: #e8eef2;
@@ -40,7 +26,7 @@
padding: 2px;
line-height: 140%;
}
-DIV.nav {
+DIV.navpath {
width: 100%;
background-color: #e8eef2;
border: 1px solid #84b0c7;
@@ -86,15 +72,43 @@
background-color: #6666cc;
color: #ffffff;
}
-A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff }
-A.el { text-decoration: none; font-weight: bold }
-A.elRef { font-weight: bold }
-A.code:link { text-decoration: none; font-weight: normal; color: #0000FF}
-A.code:visited { text-decoration: none; font-weight: normal; color: #0000FF}
-A.codeRef:link { font-weight: normal; color: #0000FF}
-A.codeRef:visited { font-weight: normal; color: #0000FF}
-A:hover { text-decoration: none; background-color: #f2f2ff }
-DL.el { margin-left: -1cm }
+A.qindexHL:visited {
+ text-decoration: none;
+ background-color: #6666cc;
+ color: #ffffff
+}
+A.el {
+ text-decoration: none;
+ font-weight: bold
+}
+A.elRef {
+ font-weight: bold
+}
+A.code:link {
+ text-decoration: none;
+ font-weight: normal;
+ color: #0000FF
+}
+A.code:visited {
+ text-decoration: none;
+ font-weight: normal;
+ color: #0000FF
+}
+A.codeRef:link {
+ font-weight: normal;
+ color: #0000FF
+}
+A.codeRef:visited {
+ font-weight: normal;
+ color: #0000FF
+}
+A:hover {
+ text-decoration: none;
+ background-color: #f2f2ff
+}
+DL.el {
+ margin-left: -1cm
+}
.fragment {
font-family: monospace, fixed;
font-size: 95%;
@@ -111,7 +125,13 @@
padding-top: 4px;
padding-bottom: 4px;
}
-DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }
+DIV.ah {
+ background-color: black;
+ font-weight: bold;
+ color: #ffffff;
+ margin-bottom: 3px;
+ margin-top: 3px
+}
DIV.groupHeader {
margin-left: 16px;
@@ -119,7 +139,11 @@
margin-bottom: 6px;
font-weight: bold;
}
-DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% }
+DIV.groupText {
+ margin-left: 16px;
+ font-style: italic;
+ font-size: 90%
+}
BODY {
background: white;
color: black;
@@ -153,11 +177,16 @@
border: 1px solid #CCCCCC;
}
TR.memlist {
- background-color: #f0f0f0;
+ background-color: #f0f0f0;
+}
+P.formulaDsp {
+ text-align: center;
+}
+IMG.formulaDsp {
+}
+IMG.formulaInl {
+ vertical-align: middle;
}
-P.formulaDsp { text-align: center; }
-IMG.formulaDsp { }
-IMG.formulaInl { vertical-align: middle; }
SPAN.keyword { color: #008000 }
SPAN.keywordtype { color: #604020 }
SPAN.keywordflow { color: #e08000 }
@@ -165,8 +194,13 @@
SPAN.preprocessor { color: #806020 }
SPAN.stringliteral { color: #002080 }
SPAN.charliteral { color: #008080 }
+SPAN.vhdldigit { color: #ff00ff }
+SPAN.vhdlchar { color: #000000 }
+SPAN.vhdlkeyword { color: #700070 }
+SPAN.vhdllogic { color: #ff0000 }
+
.mdescLeft {
- padding: 0px 8px 4px 8px;
+ padding: 0px 8px 4px 8px;
font-size: 80%;
font-style: italic;
background-color: #FAFAFA;
@@ -177,7 +211,7 @@
margin: 0px;
}
.mdescRight {
- padding: 0px 8px 4px 8px;
+ padding: 0px 8px 4px 8px;
font-size: 80%;
font-style: italic;
background-color: #FAFAFA;
@@ -274,23 +308,26 @@
border-right-style: none;
border-bottom-style: none;
border-left-style: none;
- color: #606060;
+ color: #606060;
background-color: #FAFAFA;
font-size: 80%;
}
-.search { color: #003399;
- font-weight: bold;
+.search {
+ color: #003399;
+ font-weight: bold;
}
FORM.search {
- margin-bottom: 0px;
- margin-top: 0px;
+ margin-bottom: 0px;
+ margin-top: 0px;
}
-INPUT.search { font-size: 75%;
- color: #000080;
- font-weight: normal;
- background-color: #e8eef2;
+INPUT.search {
+ font-size: 75%;
+ color: #000080;
+ font-weight: normal;
+ background-color: #e8eef2;
}
-TD.tiny { font-size: 75%;
+TD.tiny {
+ font-size: 75%;
}
a {
color: #1A41A8;
@@ -298,66 +335,70 @@
a:visited {
color: #2A3798;
}
-.dirtab { padding: 4px;
- border-collapse: collapse;
- border: 1px solid #84b0c7;
-}
-TH.dirtab { background: #e8eef2;
- font-weight: bold;
-}
-HR { height: 1px;
- border: none;
- border-top: 1px solid black;
+.dirtab {
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid #84b0c7;
+}
+TH.dirtab {
+ background: #e8eef2;
+ font-weight: bold;
+}
+HR {
+ height: 1px;
+ border: none;
+ border-top: 1px solid black;
}
/* Style for detailed member documentation */
.memtemplate {
- font-size: 80%;
- color: #606060;
- font-weight: normal;
+ font-size: 80%;
+ color: #606060;
+ font-weight: normal;
+ margin-left: 3px;
}
.memnav {
- background-color: #e8eef2;
- border: 1px solid #84b0c7;
- text-align: center;
- margin: 2px;
- margin-right: 15px;
- padding: 2px;
+ background-color: #e8eef2;
+ border: 1px solid #84b0c7;
+ text-align: center;
+ margin: 2px;
+ margin-right: 15px;
+ padding: 2px;
}
.memitem {
- padding: 4px;
- background-color: #eef3f5;
- border-width: 1px;
- border-style: solid;
- border-color: #dedeee;
- -moz-border-radius: 8px 8px 8px 8px;
+ padding: 4px;
+ background-color: #eef3f5;
+ border-width: 1px;
+ border-style: solid;
+ border-color: #dedeee;
+ -moz-border-radius: 8px 8px 8px 8px;
}
.memname {
- white-space: nowrap;
- font-weight: bold;
+ white-space: nowrap;
+ font-weight: bold;
}
.memdoc{
- padding-left: 10px;
+ padding-left: 10px;
}
.memproto {
- background-color: #d5e1e8;
- width: 100%;
- border-width: 1px;
- border-style: solid;
- border-color: #84b0c7;
- font-weight: bold;
- -moz-border-radius: 8px 8px 8px 8px;
+ background-color: #d5e1e8;
+ width: 100%;
+ border-width: 1px;
+ border-style: solid;
+ border-color: #84b0c7;
+ font-weight: bold;
+ -moz-border-radius: 8px 8px 8px 8px;
}
.paramkey {
- text-align: right;
+ text-align: right;
}
.paramtype {
- white-space: nowrap;
+ white-space: nowrap;
}
.paramname {
- color: #602020;
- font-style: italic;
- white-space: nowrap;
+ color: #602020;
+ font-style: italic;
+ white-space: nowrap;
}
/* End Styling for detailed member documentation */
@@ -366,9 +407,27 @@
font-family: sans-serif;
margin:0.5em;
}
-.directory { font-size: 9pt; font-weight: bold; }
-.directory h3 { margin: 0px; margin-top: 1em; font-size: 11pt; }
-.directory > h3 { margin-top: 0; }
-.directory p { margin: 0px; white-space: nowrap; }
-.directory div { display: none; margin: 0px; }
-.directory img { vertical-align: -30%; }
+.directory {
+ font-size: 9pt;
+ font-weight: bold;
+}
+.directory h3 {
+ margin: 0px;
+ margin-top: 1em;
+ font-size: 11pt;
+}
+.directory > h3 {
+ margin-top: 0;
+}
+.directory p {
+ margin: 0px;
+ white-space: nowrap;
+}
+.directory div {
+ display: none;
+ margin: 0px;
+}
+.directory img {
+ vertical-align: -30%;
+}
+
Modified: incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/examples.html
URL: http://svn.apache.org/viewvc/incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/examples.html?rev=783024&r1=783023&r2=783024&view=diff
==============================================================================
--- incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/examples.html (original)
+++ incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/examples.html Tue Jun 9 15:03:21 2009
@@ -1,31 +1,17 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VCL XML RPC: Examples</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.5.3 -->
-<h1>VCL XML RPC Examples</h1>Here is a list of all examples:<ul>
+<!-- Generated by Doxygen 1.5.5 -->
+<div class="contents">
+<h1>Examples</h1>Here is a list of all examples:<ul>
<li><a class="el" href="xmlrpc__example_8php-example.html">xmlrpc_example.php</a>
</ul>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 19 11:28:46 2007 for VCL XML RPC by
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 20 10:32:09 2009 for VCL XML RPC by
<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
Modified: incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/files.html
URL: http://svn.apache.org/viewvc/incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/files.html?rev=783024&r1=783023&r2=783024&view=diff
==============================================================================
--- incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/files.html (original)
+++ incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/files.html Tue Jun 9 15:03:21 2009
@@ -1,31 +1,17 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VCL XML RPC: File Index</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.5.3 -->
-<h1>VCL XML RPC File List</h1>Here is a list of all documented files with brief descriptions:<table>
- <tr><td class="indexkey">/afs/eos.ncsu.edu/engrwww/vcl.ncsu/scheduling/.ht-inc/<a class="el" href="xmlrpcWrappers_8php.html">xmlrpcWrappers.php</a></td><td class="indexvalue"></td></tr>
+<!-- Generated by Doxygen 1.5.5 -->
+<div class="contents">
+<h1>File List</h1>Here is a list of all documented files with brief descriptions:<table>
+ <tr><td class="indexkey"><a class="el" href="xmlrpcWrappers_8php.html">xmlrpcWrappers.php</a></td><td class="indexvalue"></td></tr>
</table>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 19 11:28:46 2007 for VCL XML RPC by
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 20 10:32:09 2009 for VCL XML RPC by
<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
Modified: incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/globals.html
URL: http://svn.apache.org/viewvc/incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/globals.html?rev=783024&r1=783023&r2=783024&view=diff
==============================================================================
--- incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/globals.html (original)
+++ incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/globals.html Tue Jun 9 15:03:21 2009
@@ -1,52 +1,58 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VCL XML RPC: Class Members</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.5.3 -->
-<div class="tabs">
- <ul>
- <li class="current"><a href="globals.html"><span>All</span></a></li>
- <li><a href="globals_func.html"><span>Functions</span></a></li>
- </ul>
-</div>
+<!-- Generated by Doxygen 1.5.5 -->
+ <div class="tabs">
+ <ul>
+ <li class="current"><a href="globals.html"><span>All</span></a></li>
+ <li><a href="globals_func.html"><span>Functions</span></a></li>
+ </ul>
+ </div>
+<div class="contents">
Here is a list of all documented file members with links to the documentation:
<p>
<ul>
<li>XMLRPCaddRequest()
-: <a class="el" href="xmlrpcWrappers_8php.html#e6f9d40f20e08994fa3d82c8dd12bdf5">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#e9008862ba7d032f2f7dada56b5a38ad">xmlrpcWrappers.php</a>
+<li>XMLRPCaddUserGroup()
+: <a class="el" href="xmlrpcWrappers_8php.html#c49fe2b71450a277d1640310dc8e230b">xmlrpcWrappers.php</a>
+<li>XMLRPCaddUsersToGroup()
+: <a class="el" href="xmlrpcWrappers_8php.html#fc9a41feddb3be4edafe1ad0d519e2e5">xmlrpcWrappers.php</a>
+<li>XMLRPCaffiliations()
+: <a class="el" href="xmlrpcWrappers_8php.html#f3cdb4a0c6d2fa4ca9409f2bda3c3dae">xmlrpcWrappers.php</a>
+<li>XMLRPCblockAllocation()
+: <a class="el" href="xmlrpcWrappers_8php.html#0df2e247450548835f4abdaa885753d2">xmlrpcWrappers.php</a>
+<li>XMLRPCdeleteUserGroup()
+: <a class="el" href="xmlrpcWrappers_8php.html#6109cc77232e01c3d50772c191e43aee">xmlrpcWrappers.php</a>
+<li>XMLRPCeditUserGroup()
+: <a class="el" href="xmlrpcWrappers_8php.html#f8c71512a96fa5cd7890e8fa1f0ac66a">xmlrpcWrappers.php</a>
<li>XMLRPCendRequest()
-: <a class="el" href="xmlrpcWrappers_8php.html#dfdaad6201dbcaaf5c2249a2c38437cc">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#c2303425584288df956142b63607d15b">xmlrpcWrappers.php</a>
<li>XMLRPCgetImages()
-: <a class="el" href="xmlrpcWrappers_8php.html#e2c01a27349e7a7788a42cfb5fe0d5ab">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#5bacea01de3773fb69f1cb141204b58c">xmlrpcWrappers.php</a>
<li>XMLRPCgetRequestConnectData()
-: <a class="el" href="xmlrpcWrappers_8php.html#f8b8c718ea7ea9cc973602a2fe9ae20e">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#e1d25d949e2beee11bb73248ef5890d9">xmlrpcWrappers.php</a>
<li>XMLRPCgetRequestIds()
-: <a class="el" href="xmlrpcWrappers_8php.html#815cd48d7d8c85754b2091313c02ccec">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#92ebf10589864453db3940767bc63376">xmlrpcWrappers.php</a>
<li>XMLRPCgetRequestStatus()
-: <a class="el" href="xmlrpcWrappers_8php.html#131560f1aa7577bd1da62d5b7e228e4c">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#032dc164f41a976c5d757eb7f9e984f9">xmlrpcWrappers.php</a>
+<li>XMLRPCgetUserGroupAttributes()
+: <a class="el" href="xmlrpcWrappers_8php.html#6199166923822a70e546fb5330e3c72c">xmlrpcWrappers.php</a>
+<li>XMLRPCgetUserGroupMembers()
+: <a class="el" href="xmlrpcWrappers_8php.html#a75ba57e059c75e9638b1a95bd12d6cf">xmlrpcWrappers.php</a>
+<li>XMLRPCprocessBlockTime()
+: <a class="el" href="xmlrpcWrappers_8php.html#428ab5529037c8e2d7e035c5b972aec9">xmlrpcWrappers.php</a>
+<li>XMLRPCremoveUsersFromGroup()
+: <a class="el" href="xmlrpcWrappers_8php.html#293e447aaf99c561c4247a62fff4c13f">xmlrpcWrappers.php</a>
<li>XMLRPCtest()
-: <a class="el" href="xmlrpcWrappers_8php.html#c3e09831835663a8bd79aab3f0ea3e69">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#905bda05c77ad0d7b1af805607a69ecd">xmlrpcWrappers.php</a>
</ul>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 19 11:28:46 2007 for VCL XML RPC by
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 20 10:32:09 2009 for VCL XML RPC by
<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
Modified: incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/globals_func.html
URL: http://svn.apache.org/viewvc/incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/globals_func.html?rev=783024&r1=783023&r2=783024&view=diff
==============================================================================
--- incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/globals_func.html (original)
+++ incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/globals_func.html Tue Jun 9 15:03:21 2009
@@ -1,52 +1,58 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VCL XML RPC: Class Members</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.5.3 -->
-<div class="tabs">
- <ul>
- <li><a href="globals.html"><span>All</span></a></li>
- <li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
- </ul>
-</div>
+<!-- Generated by Doxygen 1.5.5 -->
+ <div class="tabs">
+ <ul>
+ <li><a href="globals.html"><span>All</span></a></li>
+ <li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
+ </ul>
+ </div>
+<div class="contents">
<p>
<ul>
<li>XMLRPCaddRequest()
-: <a class="el" href="xmlrpcWrappers_8php.html#e6f9d40f20e08994fa3d82c8dd12bdf5">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#e9008862ba7d032f2f7dada56b5a38ad">xmlrpcWrappers.php</a>
+<li>XMLRPCaddUserGroup()
+: <a class="el" href="xmlrpcWrappers_8php.html#c49fe2b71450a277d1640310dc8e230b">xmlrpcWrappers.php</a>
+<li>XMLRPCaddUsersToGroup()
+: <a class="el" href="xmlrpcWrappers_8php.html#fc9a41feddb3be4edafe1ad0d519e2e5">xmlrpcWrappers.php</a>
+<li>XMLRPCaffiliations()
+: <a class="el" href="xmlrpcWrappers_8php.html#f3cdb4a0c6d2fa4ca9409f2bda3c3dae">xmlrpcWrappers.php</a>
+<li>XMLRPCblockAllocation()
+: <a class="el" href="xmlrpcWrappers_8php.html#0df2e247450548835f4abdaa885753d2">xmlrpcWrappers.php</a>
+<li>XMLRPCdeleteUserGroup()
+: <a class="el" href="xmlrpcWrappers_8php.html#6109cc77232e01c3d50772c191e43aee">xmlrpcWrappers.php</a>
+<li>XMLRPCeditUserGroup()
+: <a class="el" href="xmlrpcWrappers_8php.html#f8c71512a96fa5cd7890e8fa1f0ac66a">xmlrpcWrappers.php</a>
<li>XMLRPCendRequest()
-: <a class="el" href="xmlrpcWrappers_8php.html#dfdaad6201dbcaaf5c2249a2c38437cc">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#c2303425584288df956142b63607d15b">xmlrpcWrappers.php</a>
<li>XMLRPCgetImages()
-: <a class="el" href="xmlrpcWrappers_8php.html#e2c01a27349e7a7788a42cfb5fe0d5ab">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#5bacea01de3773fb69f1cb141204b58c">xmlrpcWrappers.php</a>
<li>XMLRPCgetRequestConnectData()
-: <a class="el" href="xmlrpcWrappers_8php.html#f8b8c718ea7ea9cc973602a2fe9ae20e">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#e1d25d949e2beee11bb73248ef5890d9">xmlrpcWrappers.php</a>
<li>XMLRPCgetRequestIds()
-: <a class="el" href="xmlrpcWrappers_8php.html#815cd48d7d8c85754b2091313c02ccec">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#92ebf10589864453db3940767bc63376">xmlrpcWrappers.php</a>
<li>XMLRPCgetRequestStatus()
-: <a class="el" href="xmlrpcWrappers_8php.html#131560f1aa7577bd1da62d5b7e228e4c">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#032dc164f41a976c5d757eb7f9e984f9">xmlrpcWrappers.php</a>
+<li>XMLRPCgetUserGroupAttributes()
+: <a class="el" href="xmlrpcWrappers_8php.html#6199166923822a70e546fb5330e3c72c">xmlrpcWrappers.php</a>
+<li>XMLRPCgetUserGroupMembers()
+: <a class="el" href="xmlrpcWrappers_8php.html#a75ba57e059c75e9638b1a95bd12d6cf">xmlrpcWrappers.php</a>
+<li>XMLRPCprocessBlockTime()
+: <a class="el" href="xmlrpcWrappers_8php.html#428ab5529037c8e2d7e035c5b972aec9">xmlrpcWrappers.php</a>
+<li>XMLRPCremoveUsersFromGroup()
+: <a class="el" href="xmlrpcWrappers_8php.html#293e447aaf99c561c4247a62fff4c13f">xmlrpcWrappers.php</a>
<li>XMLRPCtest()
-: <a class="el" href="xmlrpcWrappers_8php.html#c3e09831835663a8bd79aab3f0ea3e69">xmlrpcWrappers.php</a>
+: <a class="el" href="xmlrpcWrappers_8php.html#905bda05c77ad0d7b1af805607a69ecd">xmlrpcWrappers.php</a>
</ul>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 19 11:28:46 2007 for VCL XML RPC by
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 20 10:32:09 2009 for VCL XML RPC by
<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
Modified: incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/index.html
URL: http://svn.apache.org/viewvc/incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/index.html?rev=783024&r1=783023&r2=783024&view=diff
==============================================================================
--- incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/index.html (original)
+++ incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/index.html Tue Jun 9 15:03:21 2009
@@ -1,36 +1,22 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VCL XML RPC: Main Page</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.5.3 -->
+<!-- Generated by Doxygen 1.5.5 -->
+<div class="contents">
<h1>VCL XML RPC Documentation</h1>
<p>
-<ul> <li class="current"><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
-<ul> <li><a href="files.html"><span>File List</span></a></li>
+<ul> <li class="current"><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+<ul> <li><a href="files.html"><span>File List</span></a></li>
</ul>
- <li><a href="examples.html"><span>Examples</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
</ul>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 19 11:28:46 2007 for VCL XML RPC by
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 20 10:32:08 2009 for VCL XML RPC by
<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
Modified: incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/tabs.css
URL: http://svn.apache.org/viewvc/incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/tabs.css?rev=783024&r1=783023&r2=783024&view=diff
==============================================================================
--- incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/tabs.css (original)
+++ incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/tabs.css Tue Jun 9 15:03:21 2009
@@ -1,19 +1,3 @@
-/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */
DIV.tabs
@@ -110,7 +94,7 @@
padding-bottom : 6px;
}
-DIV.nav
+DIV.navpath
{
background : none;
border : none;
Modified: incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/xmlrpcWrappers_8php.html
URL: http://svn.apache.org/viewvc/incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/xmlrpcWrappers_8php.html?rev=783024&r1=783023&r2=783024&view=diff
==============================================================================
--- incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/xmlrpcWrappers_8php.html (original)
+++ incubator/vcl/trunk/web/.ht-inc/xmlrpcdocs/xmlrpcWrappers_8php.html Tue Jun 9 15:03:21 2009
@@ -1,58 +1,88 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
-<title>VCL XML RPC: /afs/eos.ncsu.edu/engrwww/vcl.ncsu/scheduling/.ht-inc/xmlrpcWrappers.php File Reference</title>
+<title>VCL XML RPC: xmlrpcWrappers.php File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.5.3 -->
-<h1>/afs/eos.ncsu.edu/engrwww/vcl.ncsu/scheduling/.ht-inc/xmlrpcWrappers.php File Reference</h1><table border="0" cellpadding="0" cellspacing="0">
+<!-- Generated by Doxygen 1.5.5 -->
+<div class="contents">
+<h1>xmlrpcWrappers.php File Reference</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#e2c01a27349e7a7788a42cfb5fe0d5ab">XMLRPCgetImages</a> ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#f3cdb4a0c6d2fa4ca9409f2bda3c3dae">XMLRPCaffiliations</a> ()</td></tr>
-<tr><td class="mdescLeft"> </td><td class="mdescRight">gets the images to which the user has acces <a href="#e2c01a27349e7a7788a42cfb5fe0d5ab"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#e6f9d40f20e08994fa3d82c8dd12bdf5">XMLRPCaddRequest</a> ($imageid, $start, $length, $foruser='')</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">gets all of the affilations for which users can log in to VCL<br>
+ <b>NOTE:</b> This is the only function available for which the X-User and X-Pass HTTP headers do not need to be passed <a href="#f3cdb4a0c6d2fa4ca9409f2bda3c3dae"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#5bacea01de3773fb69f1cb141204b58c">XMLRPCgetImages</a> ()</td></tr>
-<tr><td class="mdescLeft"> </td><td class="mdescRight">tries to make a request <a href="#e6f9d40f20e08994fa3d82c8dd12bdf5"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#131560f1aa7577bd1da62d5b7e228e4c">XMLRPCgetRequestStatus</a> ($requestid)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">gets the images to which the user has acces <a href="#5bacea01de3773fb69f1cb141204b58c"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#e9008862ba7d032f2f7dada56b5a38ad">XMLRPCaddRequest</a> ($imageid, $start, $length, $foruser='')</td></tr>
-<tr><td class="mdescLeft"> </td><td class="mdescRight">determines and returns the status of the request <a href="#131560f1aa7577bd1da62d5b7e228e4c"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#f8b8c718ea7ea9cc973602a2fe9ae20e">XMLRPCgetRequestConnectData</a> ($requestid, $remoteIP)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">tries to make a request <a href="#e9008862ba7d032f2f7dada56b5a38ad"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#032dc164f41a976c5d757eb7f9e984f9">XMLRPCgetRequestStatus</a> ($requestid)</td></tr>
-<tr><td class="mdescLeft"> </td><td class="mdescRight">if request is ready, adds the connecting user's computer to the request and returns info about how to connect to the computer <a href="#f8b8c718ea7ea9cc973602a2fe9ae20e"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#dfdaad6201dbcaaf5c2249a2c38437cc">XMLRPCendRequest</a> ($requestid)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">determines and returns the status of the request <a href="#032dc164f41a976c5d757eb7f9e984f9"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#e1d25d949e2beee11bb73248ef5890d9">XMLRPCgetRequestConnectData</a> ($requestid, $remoteIP)</td></tr>
-<tr><td class="mdescLeft"> </td><td class="mdescRight">ends/deletes a request <a href="#dfdaad6201dbcaaf5c2249a2c38437cc"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#815cd48d7d8c85754b2091313c02ccec">XMLRPCgetRequestIds</a> ()</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">if request is ready, adds the connecting user's computer to the request and returns info about how to connect to the computer <a href="#e1d25d949e2beee11bb73248ef5890d9"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#c2303425584288df956142b63607d15b">XMLRPCendRequest</a> ($requestid)</td></tr>
-<tr><td class="mdescLeft"> </td><td class="mdescRight">gets information about all of user's requests <a href="#815cd48d7d8c85754b2091313c02ccec"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#c3e09831835663a8bd79aab3f0ea3e69">XMLRPCtest</a> ($string)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">ends/deletes a request <a href="#c2303425584288df956142b63607d15b"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#92ebf10589864453db3940767bc63376">XMLRPCgetRequestIds</a> ()</td></tr>
-<tr><td class="mdescLeft"> </td><td class="mdescRight">this is a test function that call be called when getting XML RPC calls to this site to work <a href="#c3e09831835663a8bd79aab3f0ea3e69"></a><br></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">gets information about all of user's requests <a href="#92ebf10589864453db3940767bc63376"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#0df2e247450548835f4abdaa885753d2">XMLRPCblockAllocation</a> ($imageid, $start, $end, $requestcount, $usergroupid, $ignoreprivileges=0)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">creates and processes a block reservation according to the passed in criteria <a href="#0df2e247450548835f4abdaa885753d2"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#428ab5529037c8e2d7e035c5b972aec9">XMLRPCprocessBlockTime</a> ($blockTimesid, $ignoreprivileges=0)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">processes a block reservation for the blockTimes entry associated with blockTimesid <a href="#428ab5529037c8e2d7e035c5b972aec9"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#c49fe2b71450a277d1640310dc8e230b">XMLRPCaddUserGroup</a> ($name, $affiliation, $owner, $managingGroup, $initialMaxTime, $totalMaxTime, $maxExtendTime)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">creates a new user group with the specified parameters <a href="#c49fe2b71450a277d1640310dc8e230b"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#6199166923822a70e546fb5330e3c72c">XMLRPCgetUserGroupAttributes</a> ($name, $affiliation)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">gets information about a user group <a href="#6199166923822a70e546fb5330e3c72c"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#6109cc77232e01c3d50772c191e43aee">XMLRPCdeleteUserGroup</a> ($name, $affiliation)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">deletes a user group along with all of its privileges <a href="#6109cc77232e01c3d50772c191e43aee"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#f8c71512a96fa5cd7890e8fa1f0ac66a">XMLRPCeditUserGroup</a> ($name, $affiliation, $newName, $newAffiliation, $newOwner='', $newManagingGroup='', $newInitialMaxTime='', $newTotalMaxTime='', $newMaxExtendTime='')</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">modifies attributes of a user group<br>
+ <b>NOTE:</b> an empty string may be passed for any of the new* fields to leave that item unchanged <a href="#f8c71512a96fa5cd7890e8fa1f0ac66a"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a75ba57e059c75e9638b1a95bd12d6cf">XMLRPCgetUserGroupMembers</a> ($name, $affiliation)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">gets members of a user group<br>
+ <b>Note:</b> it is possible to have a group with no members in which case success will be returned with an empty array for members <a href="#a75ba57e059c75e9638b1a95bd12d6cf"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#fc9a41feddb3be4edafe1ad0d519e2e5">XMLRPCaddUsersToGroup</a> ($name, $affiliation, $users)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">adds users to a group <a href="#fc9a41feddb3be4edafe1ad0d519e2e5"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#293e447aaf99c561c4247a62fff4c13f">XMLRPCremoveUsersFromGroup</a> ($name, $affiliation, $users)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">removes users from a group <a href="#293e447aaf99c561c4247a62fff4c13f"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#905bda05c77ad0d7b1af805607a69ecd">XMLRPCtest</a> ($string)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">this is a test function that call be called when getting XML RPC calls to this site to work <a href="#905bda05c77ad0d7b1af805607a69ecd"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The functions listed here are for making VCL requests from other applications. They are implemented according to the XML RPC spec defined at <a href="http://www.xmlrpc.com/">http://www.xmlrpc.com/</a> <br>
- There is one function called <b><a class="el" href="xmlrpcWrappers_8php.html#c3e09831835663a8bd79aab3f0ea3e69" title="this is a test function that call be called when getting XML RPC calls to this site...">XMLRPCtest()</a></b> that can be used during initial development to get started without actually making a request.<br>
+ There is one function called <b><a class="el" href="xmlrpcWrappers_8php.html#905bda05c77ad0d7b1af805607a69ecd" title="this is a test function that call be called when getting XML RPC calls to this site...">XMLRPCtest()</a></b> that can be used during initial development to get started without actually making a request.<br>
<br>
- The URL you will use to submit RPC calls is<br>
+ The URL you will use to submit RPC calls is the URL for your VCL site followed by<br>
+<br>
+ index.php?mode=xmlrpccall<br>
+<br>
+ for example if the URL for your VCL site is<br>
+<br>
+ <a href="https://vcl.mysite.org/vcl/">https://vcl.mysite.org/vcl/</a><br>
+<br>
+ the RPC URL would be<br>
<br>
- <a href="https://vcl.ncsu.edu/scheduling/index.php?mode=xmlrpccall">https://vcl.ncsu.edu/scheduling/index.php?mode=xmlrpccall</a><br>
+ <a href="https://vcl.mysite.org/vcl/index.php?mode=xmlrpccall">https://vcl.mysite.org/vcl/index.php?mode=xmlrpccall</a><br>
+<br>
+ There is one exception - when calling the XMLRPCaffiliations function, the mode is xmlrpcaffiliations, for example:<br>
+<br>
+ <a href="https://vcl.mysite.org/vcl/index.php?mode=xmlrpcaffiliations">https://vcl.mysite.org/vcl/index.php?mode=xmlrpcaffiliations</a><br>
<br>
Your application must connect using HTTPS.<br>
<br>
@@ -63,18 +93,21 @@
<br>
Authentication is handled by 2 additional HTTP headers you will need to send:<br>
<b>X-User</b> - the userid you would use to log in to the VCL site, followed by the at sign (@), followed by your affiliation<br>
- example: myuserid@NCSU - currently, you need to contact <a href="mailto:vcl_help@ncsu.edu">vcl_help@ncsu.edu</a> to find out your affiliation, but in the future there will be an API method of obtaining this<br>
+ example: myuserid@NCSU<br>
+ You can obtain a list of the affiliations by using the <a class="el" href="xmlrpcWrappers_8php.html#f3cdb4a0c6d2fa4ca9409f2bda3c3dae" title="gets all of the affilations for which users can log in to VCL NOTE: This is the...">XMLRPCaffiliations()</a> call<br>
+<br>
<b>X-Pass</b> - the password you would use to log in to the VCL site<br>
<br>
There is one other additional HTTP header you must send:<br>
<b>X-APIVERSION</b> - set this to 2<br>
<br>
-<p>
+ The X-User and X-Pass HTTP headers do not need to be passed to call the <a class="el" href="xmlrpcWrappers_8php.html#f3cdb4a0c6d2fa4ca9409f2bda3c3dae" title="gets all of the affilations for which users can log in to VCL NOTE: This is the...">XMLRPCaffiliations()</a> function.<p>
<h2>API Version 1</h2>
<p>
-This version is being phased out in favor of version 2. Documentation is provided for those currently using version 1 who are not ready to switch to using version 2.<br>
+<b>NOTICE:</b> API version 1 will probably be removed in VCL 2.2. If you are still using API version 1, you need to update your code to use version 2.<br>
+<br>
+ This version is being phased out in favor of version 2. Documentation is provided for those currently using version 1 who are not ready to switch to using version 2.<br>
<br>
- To connect to VCL with XML RPC, you will need to obtain a key. Contact <a href="mailto:vcl_help@ncsu.edu">vcl_help@ncsu.edu</a> to get one.<br>
<p>
Authentication is handled by 2 additional HTTP headers you will need to send:<br>
<b>X-User</b> - use the same id you would use to log in to the VCL site<br>
@@ -83,12 +116,12 @@
There is one other additional HTTP header you must send:<br>
<b>X-APIVERSION</b> - set this to 1<br>
<hr><h2>Function Documentation</h2>
-<a class="anchor" name="e6f9d40f20e08994fa3d82c8dd12bdf5"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCaddRequest" ref="e6f9d40f20e08994fa3d82c8dd12bdf5" args="($imageid, $start, $length, $foruser='')" -->
+<a class="anchor" name="e9008862ba7d032f2f7dada56b5a38ad"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCaddRequest" ref="e9008862ba7d032f2f7dada56b5a38ad" args="($imageid, $start, $length, $foruser='')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">function XMLRPCaddRequest </td>
+ <td class="memname">XMLRPCaddRequest </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>imageid</em>, </td>
@@ -143,16 +176,390 @@
<li><b>requestid</b> - identifier that should be passed to later calls when acting on the request </li>
</ul>
</dd></dl>
-<dl compact><dt><b>Examples: </b></dt><dd>
-<a class="el" href="xmlrpc__example_8php-example.html#a2">xmlrpc_example.php</a>.</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="c49fe2b71450a277d1640310dc8e230b"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCaddUserGroup" ref="c49fe2b71450a277d1640310dc8e230b" args="($name, $affiliation, $owner, $managingGroup, $initialMaxTime, $totalMaxTime, $maxExtendTime)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">XMLRPCaddUserGroup </td>
+ <td>(</td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>name</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>affiliation</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>owner</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>managingGroup</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>initialMaxTime</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>totalMaxTime</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>maxExtendTime</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+creates a new user group with the specified parameters
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$name</em> </td><td>- name of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$affiliation</em> </td><td>- affiliation of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$owner</em> </td><td>- user that will be the owner of the group in username@affiliation form </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$managingGroup</em> </td><td>- user group that can manage membership of this one </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$initialMaxTime</em> </td><td>- (minutes) max initial time users in this group can select for length of reservations </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$totalMaxTime</em> </td><td>- (minutes) total length users in the group can have for a reservation (including all extensions) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$maxExtendTime</em> </td><td>- (minutes) max length of time users can request as an extension to a reservation at a time</td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array with at least one index named 'status' which will have one of these values:<br>
+ <b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
+<li><b>errorcode</b> - error number </li>
+<li><b>errormsg</b> - error string</li>
+</ul>
+<b>success</b> - user group was successfully created</dd></dl>
+/////////////////////////////////////////////////////////////////////////////
+</div>
+</div><p>
+<a class="anchor" name="fc9a41feddb3be4edafe1ad0d519e2e5"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCaddUsersToGroup" ref="fc9a41feddb3be4edafe1ad0d519e2e5" args="($name, $affiliation, $users)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">XMLRPCaddUsersToGroup </td>
+ <td>(</td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>name</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>affiliation</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>users</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+adds users to a group
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$name</em> </td><td>- name of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$affiliation</em> </td><td>- affiliation of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$users</em> </td><td>- array of users in username@affiliation form to be added to the group</td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array with at least one index named 'status' which will have one of these values:<br>
+ <b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
+<li><b>errorcode</b> - error number </li>
+<li><b>errormsg</b> - error string</li>
+</ul>
+<b>success</b> - users successfully added to the group</dd></dl>
+<b>warning</b> - there was a non-fatal issue that occurred while processing the call; there will be three additional elements in this case: <ul>
+<li><b>warningcode</b> - warning number </li>
+<li><b>warningmsg</b> - warning string </li>
+<li><b>failedusers</b> - array of users in username@affiliation form that could not be added</li>
+</ul>
+/////////////////////////////////////////////////////////////////////////////
</div>
</div><p>
-<a class="anchor" name="dfdaad6201dbcaaf5c2249a2c38437cc"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCendRequest" ref="dfdaad6201dbcaaf5c2249a2c38437cc" args="($requestid)" -->
+<a class="anchor" name="f3cdb4a0c6d2fa4ca9409f2bda3c3dae"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCaffiliations" ref="f3cdb4a0c6d2fa4ca9409f2bda3c3dae" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">function XMLRPCendRequest </td>
+ <td class="memname">XMLRPCaffiliations </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td> ) </td>
+ <td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+gets all of the affilations for which users can log in to VCL<br>
+ <b>NOTE:</b> This is the only function available for which the X-User and X-Pass HTTP headers do not need to be passed
+<p>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array of affiliation arrays, each with 2 indices:<br>
+ <b>id</b> - id of the affiliation<br>
+ <b>name</b> - name of the affiliation </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="0df2e247450548835f4abdaa885753d2"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCblockAllocation" ref="0df2e247450548835f4abdaa885753d2" args="($imageid, $start, $end, $requestcount, $usergroupid, $ignoreprivileges=0)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">XMLRPCblockAllocation </td>
+ <td>(</td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>imageid</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>start</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>end</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>requestcount</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>usergroupid</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>ignoreprivileges</em> = <code>0</code></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+creates and processes a block reservation according to the passed in criteria
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$imageid</em> </td><td>- id of the image to be used </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$start</em> </td><td>- mysql datetime for the start time (i.e. requests should be prep'd and ready by this time) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$end</em> </td><td>- mysql datetime for the end time </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$requestcount</em> </td><td>- number of computers to allocate </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$usergroupid</em> </td><td>- id of user group for checking user access to machines </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$ignoreprivileges</em> </td><td>(optional, default=0) - 0 (false) or 1 (true) - set to 1 to select computers from any that are mapped to be able to run the image; set to 0 to only select computers from ones that are both mapped and that users in the usergroup assigned to this block request have been granted access to through the privilege tree</td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array with blockTimesid as an index with the value of the newly created block time and at least one other index named 'status' which will have one of these values:<br>
+ <b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
+<li><b>errorcode</b> - error number </li>
+<li><b>errormsg</b> - error string</li>
+</ul>
+<b>success</b> - blockTimesid was processed; there will be two additional elements in this case: <ul>
+<li><b>allocated</b> - total number of desired requests that have been allocated </li>
+<li><b>unallocated</b> - total number of desired requests that have not been allocated</li>
+</ul>
+<b>warning</b> - there was a non-fatal issue that occurred while processing the call; there will be four additional elements in this case: <ul>
+<li><b>warningcode</b> - warning number </li>
+<li><b>warningmsg</b> - warning string </li>
+<li><b>allocated</b> - total number of desired requests that have been allocated </li>
+<li><b>unallocated</b> - total number of desired requests that have not been allocated</li>
+</ul>
+note that status may be warning, but allocated may be 0 indicating there were no errors that occurred, but there simply were not any machines available </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="6109cc77232e01c3d50772c191e43aee"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCdeleteUserGroup" ref="6109cc77232e01c3d50772c191e43aee" args="($name, $affiliation)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">XMLRPCdeleteUserGroup </td>
+ <td>(</td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>name</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>affiliation</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+deletes a user group along with all of its privileges
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$name</em> </td><td>- name of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$affiliation</em> </td><td>- affiliation of user group</td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array with at least one index named 'status' which will have one of these values:<br>
+ <b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
+<li><b>errorcode</b> - error number </li>
+<li><b>errormsg</b> - error string</li>
+</ul>
+<b>success</b> - user group was successfully deleted</dd></dl>
+/////////////////////////////////////////////////////////////////////////////
+</div>
+</div><p>
+<a class="anchor" name="f8c71512a96fa5cd7890e8fa1f0ac66a"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCeditUserGroup" ref="f8c71512a96fa5cd7890e8fa1f0ac66a" args="($name, $affiliation, $newName, $newAffiliation, $newOwner='', $newManagingGroup='', $newInitialMaxTime='', $newTotalMaxTime='', $newMaxExtendTime='')" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">XMLRPCeditUserGroup </td>
+ <td>(</td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>name</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>affiliation</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>newName</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>newAffiliation</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>newOwner</em> = <code>''</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>newManagingGroup</em> = <code>''</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>newInitialMaxTime</em> = <code>''</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>newTotalMaxTime</em> = <code>''</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>newMaxExtendTime</em> = <code>''</code></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+modifies attributes of a user group<br>
+ <b>NOTE:</b> an empty string may be passed for any of the new* fields to leave that item unchanged
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$name</em> </td><td>- name of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$affiliation</em> </td><td>- affiliation of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$newName</em> </td><td>- new name for user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$newAffiliation</em> </td><td>- new affiliation for user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$newOwner</em> </td><td>- (optional, default='') user that will be the owner of the group in username@affiliation form </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$newManagingGroup</em> </td><td>- (optional, default='') user group that can manage membership of this one </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$newInitialMaxTime</em> </td><td>- (optional, default='') (minutes) max initial time users in this group can select for length of reservations </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$newTotalMaxTime</em> </td><td>- (optional, default='') (minutes) total length users in the group can have for a reservation (including all extensions) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$newMaxExtendTime</em> </td><td>- (optional, default='') (minutes) max length of time users can request as an extension to a reservation at a time</td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array with at least one index named 'status' which will have one of these values:<br>
+ <b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
+<li><b>errorcode</b> - error number </li>
+<li><b>errormsg</b> - error string</li>
+</ul>
+<b>success</b> - user group was successfully updated</dd></dl>
+/////////////////////////////////////////////////////////////////////////////
+</div>
+</div><p>
+<a class="anchor" name="c2303425584288df956142b63607d15b"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCendRequest" ref="c2303425584288df956142b63607d15b" args="($requestid)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">XMLRPCendRequest </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>requestid</em> </td>
@@ -180,16 +587,15 @@
</ul>
<b>success</b> - request was successfully ended<br>
</dd></dl>
-<dl compact><dt><b>Examples: </b></dt><dd>
-<a class="el" href="xmlrpc__example_8php-example.html#a5">xmlrpc_example.php</a>.</dl>
+
</div>
</div><p>
-<a class="anchor" name="e2c01a27349e7a7788a42cfb5fe0d5ab"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCgetImages" ref="e2c01a27349e7a7788a42cfb5fe0d5ab" args="()" -->
+<a class="anchor" name="5bacea01de3773fb69f1cb141204b58c"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCgetImages" ref="5bacea01de3773fb69f1cb141204b58c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">function XMLRPCgetImages </td>
+ <td class="memname">XMLRPCgetImages </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
@@ -205,16 +611,15 @@
<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array of image arrays, each with 2 indices:<br>
<b>id</b> - id of the image<br>
<b>name</b> - name of the image </dd></dl>
-<dl compact><dt><b>Examples: </b></dt><dd>
-<a class="el" href="xmlrpc__example_8php-example.html#a1">xmlrpc_example.php</a>.</dl>
+
</div>
</div><p>
-<a class="anchor" name="f8b8c718ea7ea9cc973602a2fe9ae20e"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCgetRequestConnectData" ref="f8b8c718ea7ea9cc973602a2fe9ae20e" args="($requestid, $remoteIP)" -->
+<a class="anchor" name="e1d25d949e2beee11bb73248ef5890d9"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCgetRequestConnectData" ref="e1d25d949e2beee11bb73248ef5890d9" args="($requestid, $remoteIP)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">function XMLRPCgetRequestConnectData </td>
+ <td class="memname">XMLRPCgetRequestConnectData </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>requestid</em>, </td>
@@ -256,16 +661,15 @@
<li><b>password</b> - password to use when connecting to the machine</li>
</ul>
<b>notready</b> - request is not ready for connection </dd></dl>
-<dl compact><dt><b>Examples: </b></dt><dd>
-<a class="el" href="xmlrpc__example_8php-example.html#a4">xmlrpc_example.php</a>.</dl>
+
</div>
</div><p>
-<a class="anchor" name="815cd48d7d8c85754b2091313c02ccec"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCgetRequestIds" ref="815cd48d7d8c85754b2091313c02ccec" args="()" -->
+<a class="anchor" name="92ebf10589864453db3940767bc63376"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCgetRequestIds" ref="92ebf10589864453db3940767bc63376" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">function XMLRPCgetRequestIds </td>
+ <td class="memname">XMLRPCgetRequestIds </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
@@ -301,12 +705,12 @@
</div>
</div><p>
-<a class="anchor" name="131560f1aa7577bd1da62d5b7e228e4c"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCgetRequestStatus" ref="131560f1aa7577bd1da62d5b7e228e4c" args="($requestid)" -->
+<a class="anchor" name="032dc164f41a976c5d757eb7f9e984f9"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCgetRequestStatus" ref="032dc164f41a976c5d757eb7f9e984f9" args="($requestid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">function XMLRPCgetRequestStatus </td>
+ <td class="memname">XMLRPCgetRequestStatus </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>requestid</em> </td>
@@ -340,16 +744,221 @@
</li>
</ul>
<b>future</b> - start time of request is in the future </dd></dl>
-<dl compact><dt><b>Examples: </b></dt><dd>
-<a class="el" href="xmlrpc__example_8php-example.html#a3">xmlrpc_example.php</a>.</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="6199166923822a70e546fb5330e3c72c"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCgetUserGroupAttributes" ref="6199166923822a70e546fb5330e3c72c" args="($name, $affiliation)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">XMLRPCgetUserGroupAttributes </td>
+ <td>(</td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>name</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>affiliation</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+gets information about a user group
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$name</em> </td><td>- name of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$affiliation</em> </td><td>- affiliation of user group</td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array with at least one index named 'status' which will have one of these values:<br>
+ <b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
+<li><b>errorcode</b> - error number </li>
+<li><b>errormsg</b> - error string</li>
+</ul>
+<b>success</b> - there will be five additional elements in this case: <ul>
+<li><b>owner</b> - user that will be the owner of the group in username@affiliation form </li>
+<li><b>managingGroup</b> - user group that can manage membership of this one in groupname@affiliation form </li>
+<li><b>initialMaxTime</b> - (minutes) max initial time users in this group can select for length of reservations </li>
+<li><b>totalMaxTime</b> - (minutes) total length users in the group can have for a reservation (including all extensions) </li>
+<li><b>maxExtendTime</b> - (minutes) max length of time users can request as an extension to a reservation at a time</li>
+</ul>
+///////////////////////////////////////////////////////////////////////////// </dd></dl>
+
</div>
</div><p>
-<a class="anchor" name="c3e09831835663a8bd79aab3f0ea3e69"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCtest" ref="c3e09831835663a8bd79aab3f0ea3e69" args="($string)" -->
+<a class="anchor" name="a75ba57e059c75e9638b1a95bd12d6cf"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCgetUserGroupMembers" ref="a75ba57e059c75e9638b1a95bd12d6cf" args="($name, $affiliation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">function XMLRPCtest </td>
+ <td class="memname">XMLRPCgetUserGroupMembers </td>
+ <td>(</td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>name</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>affiliation</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+gets members of a user group<br>
+ <b>Note:</b> it is possible to have a group with no members in which case success will be returned with an empty array for members
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$name</em> </td><td>- name of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$affiliation</em> </td><td>- affiliation of user group</td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array with at least one index named 'status' which will have one of these values:<br>
+ <b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
+<li><b>errorcode</b> - error number </li>
+<li><b>errormsg</b> - error string</li>
+</ul>
+<b>success</b> - there will be one additional element in this case: <ul>
+<li><b>members</b> - array of members of the group in username@affiliation form</li>
+</ul>
+///////////////////////////////////////////////////////////////////////////// </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="428ab5529037c8e2d7e035c5b972aec9"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCprocessBlockTime" ref="428ab5529037c8e2d7e035c5b972aec9" args="($blockTimesid, $ignoreprivileges=0)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">XMLRPCprocessBlockTime </td>
+ <td>(</td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>blockTimesid</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>ignoreprivileges</em> = <code>0</code></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+processes a block reservation for the blockTimes entry associated with blockTimesid
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$blockTimesid</em> </td><td>- id from the blockTimes table </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$ignoreprivileges</em> </td><td>(optional, default=0) - 0 (false) or 1 (true) - set to 1 to select computers from any that are mapped to be able to run the image; set to 0 to only select computers from ones that are both mapped and that users in the usergroup assigned to this block request have been granted access to through the privilege tree</td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array with at least one index named 'status' which will have one of these values:<br>
+ <b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
+<li><b>errorcode</b> - error number </li>
+<li><b>errormsg</b> - error string</li>
+</ul>
+<b>completed</b> - blockTimesid was previously successfully processed<br>
+ <b>success</b> - blockTimesid was processed; there will be two additional elements in this case: <ul>
+<li><b>allocated</b> - total number of desired requests that have been allocated </li>
+<li><b>unallocated</b> - total number of desired requests that have not been allocated</li>
+</ul>
+<b>warning</b> - there was a non-fatal issue that occurred while processing the call; there will be four additional elements in this case: <ul>
+<li><b>warningcode</b> - warning number </li>
+<li><b>warningmsg</b> - warning string </li>
+<li><b>allocated</b> - total number of desired requests that have been allocated </li>
+<li><b>unallocated</b> - total number of desired requests that have not been allocated</li>
+</ul>
+note that status may be warning, but allocated may be 0 indicating there were no errors that occurred, but there simply were not any machines available </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="293e447aaf99c561c4247a62fff4c13f"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCremoveUsersFromGroup" ref="293e447aaf99c561c4247a62fff4c13f" args="($name, $affiliation, $users)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">XMLRPCremoveUsersFromGroup </td>
+ <td>(</td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>name</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>affiliation</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$ </td>
+ <td class="paramname"> <em>users</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+removes users from a group
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$name</em> </td><td>- name of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$affiliation</em> </td><td>- affiliation of user group </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$users</em> </td><td>- array of users in username@affiliation form to be removed from the group</td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>an array with at least one index named 'status' which will have one of these values:<br>
+ <b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
+<li><b>errorcode</b> - error number </li>
+<li><b>errormsg</b> - error string</li>
+</ul>
+<b>success</b> - users successfully removed from the group</dd></dl>
+<b>warning</b> - there was a non-fatal issue that occurred while processing the call; there will be three additional elements in this case: <ul>
+<li><b>warningcode</b> - warning number </li>
+<li><b>warningmsg</b> - warning string </li>
+<li><b>failedusers</b> - array of users in username@affiliation form that could not be removed</li>
+</ul>
+/////////////////////////////////////////////////////////////////////////////
+</div>
+</div><p>
+<a class="anchor" name="905bda05c77ad0d7b1af805607a69ecd"></a><!-- doxytag: member="xmlrpcWrappers.php::XMLRPCtest" ref="905bda05c77ad0d7b1af805607a69ecd" args="($string)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">XMLRPCtest </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>string</em> </td>
@@ -372,12 +981,12 @@
<b>status</b> - will be 'success'<br>
<b>message</b> - will be 'RPC call worked successfully'<br>
<b>string</b> - contents of $string (after being sanatized) </dd></dl>
-<dl compact><dt><b>Examples: </b></dt><dd>
-<a class="el" href="xmlrpc__example_8php-example.html#a0">xmlrpc_example.php</a>.</dl>
+
</div>
</div><p>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 19 11:28:46 2007 for VCL XML RPC by
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 20 10:32:09 2009 for VCL XML RPC by
<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>