File: C:/Ruby27-x64/share/doc/ruby/html/WIN32OLE_PARAM.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WIN32OLE_PARAM - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>
<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>
<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="./index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-default">#default</a>
<li ><a href="#method-i-input-3F">#input?</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-name">#name</a>
<li ><a href="#method-i-ole_type">#ole_type</a>
<li ><a href="#method-i-ole_type_detail">#ole_type_detail</a>
<li ><a href="#method-i-optional-3F">#optional?</a>
<li ><a href="#method-i-output-3F">#output?</a>
<li ><a href="#method-i-retval-3F">#retval?</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WIN32OLE_PARAM">
<h1 id="class-WIN32OLE_PARAM" class="class">
class WIN32OLE_PARAM
</h1>
<section class="description">
<p><code>WIN32OLE_PARAM</code> objects represent param information of the OLE method.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
new(method, n) → WIN32OLE_PARAM object
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <a href="WIN32OLE_PARAM.html"><code>WIN32OLE_PARAM</code></a> object which represents OLE parameter information. 1st argument should be <a href="WIN32OLE_METHOD.html"><code>WIN32OLE_METHOD</code></a> object. 2nd argument `n' is n-th parameter of the method specified by 1st argument.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Scripting Runtime'</span>, <span class="ruby-string">'IFileSystem'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'CreateTextFile'</span>)
<span class="ruby-identifier">param</span> = <span class="ruby-constant">WIN32OLE_PARAM</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">method</span>, <span class="ruby-value">2</span>) <span class="ruby-comment"># => #<WIN32OLE_PARAM:Overwrite=true></span>
</pre>
<div class="method-source-code" id="new-source">
<pre>static VALUE
foleparam_initialize(VALUE self, VALUE olemethod, VALUE n)
{
int idx;
if (!rb_obj_is_kind_of(olemethod, cWIN32OLE_METHOD)) {
rb_raise(rb_eTypeError, "1st parameter must be WIN32OLE_METHOD object");
}
idx = RB_FIX2INT(n);
return oleparam_ole_param(self, olemethod, idx);
}</pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-default" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_PARAM#default
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns default value. If the default value does not exist, this method returns nil.</p>
<pre>tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
method.params.each do |param|
if param.default
puts "#{param.name} (= #{param.default})"
else
puts "#{param}"
end
end
The above script result is following:
Filename
FileFormat
Password
WriteResPassword
ReadOnlyRecommended
CreateBackup
AccessMode (= 1)
ConflictResolution
AddToMru
TextCodepage
TextVisualLayout</pre>
<div class="method-source-code" id="default-source">
<pre>static VALUE
foleparam_default(VALUE self)
{
struct oleparamdata *pparam;
TypedData_Get_Struct(self, struct oleparamdata, &oleparam_datatype, pparam);
return ole_param_default(pparam->pTypeInfo, pparam->method_index,
pparam->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-input-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_PARAM#input?
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the parameter is input.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbook'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SaveAs'</span>)
<span class="ruby-identifier">param1</span> = <span class="ruby-identifier">method</span>.<span class="ruby-identifier">params</span>[<span class="ruby-value">0</span>]
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">param1</span>.<span class="ruby-identifier">input?</span> <span class="ruby-comment"># => true</span>
</pre>
<div class="method-source-code" id="input-3F-source">
<pre>static VALUE
foleparam_input(VALUE self)
{
struct oleparamdata *pparam;
TypedData_Get_Struct(self, struct oleparamdata, &oleparam_datatype, pparam);
return ole_param_flag_mask(pparam->pTypeInfo, pparam->method_index,
pparam->index, PARAMFLAG_FIN);
}</pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_PARAM#inspect → String
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the parameter name with class name. If the parameter has default value, then returns name=value string with class name.</p>
<div class="method-source-code" id="inspect-source">
<pre>static VALUE
foleparam_inspect(VALUE self)
{
VALUE detail = foleparam_name(self);
VALUE defval = foleparam_default(self);
if (defval != Qnil) {
rb_str_cat2(detail, "=");
rb_str_concat(detail, rb_inspect(defval));
}
return make_inspect("WIN32OLE_PARAM", detail);
}</pre>
</div>
</div>
</div>
<div id="method-i-name" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_PARAM#name
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns name.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbook'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SaveAs'</span>)
<span class="ruby-identifier">param1</span> = <span class="ruby-identifier">method</span>.<span class="ruby-identifier">params</span>[<span class="ruby-value">0</span>]
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">param1</span>.<span class="ruby-identifier">name</span> <span class="ruby-comment"># => Filename</span>
</pre>
<div class="method-source-code" id="name-source">
<pre>static VALUE
foleparam_name(VALUE self)
{
return rb_ivar_get(self, rb_intern("name"));
}</pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="WIN32OLE_PARAM.html#method-i-to_s">to_s</a>
</div>
</div>
<div id="method-i-ole_type" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_PARAM#ole_type
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns OLE type of <a href="WIN32OLE_PARAM.html"><code>WIN32OLE_PARAM</code></a> object(parameter of OLE method).</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbook'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SaveAs'</span>)
<span class="ruby-identifier">param1</span> = <span class="ruby-identifier">method</span>.<span class="ruby-identifier">params</span>[<span class="ruby-value">0</span>]
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">param1</span>.<span class="ruby-identifier">ole_type</span> <span class="ruby-comment"># => VARIANT</span>
</pre>
<div class="method-source-code" id="ole_type-source">
<pre>static VALUE
foleparam_ole_type(VALUE self)
{
struct oleparamdata *pparam;
TypedData_Get_Struct(self, struct oleparamdata, &oleparam_datatype, pparam);
return ole_param_ole_type(pparam->pTypeInfo, pparam->method_index,
pparam->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-ole_type_detail" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_PARAM#ole_type_detail
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns detail information of type of argument.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'IWorksheetFunction'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SumIf'</span>)
<span class="ruby-identifier">param1</span> = <span class="ruby-identifier">method</span>.<span class="ruby-identifier">params</span>[<span class="ruby-value">0</span>]
<span class="ruby-identifier">p</span> <span class="ruby-identifier">param1</span>.<span class="ruby-identifier">ole_type_detail</span> <span class="ruby-comment"># => ["PTR", "USERDEFINED", "Range"]</span>
</pre>
<div class="method-source-code" id="ole_type_detail-source">
<pre>static VALUE
foleparam_ole_type_detail(VALUE self)
{
struct oleparamdata *pparam;
TypedData_Get_Struct(self, struct oleparamdata, &oleparam_datatype, pparam);
return ole_param_ole_type_detail(pparam->pTypeInfo, pparam->method_index,
pparam->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-optional-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_PARAM#optional?
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if argument is optional.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbook'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SaveAs'</span>)
<span class="ruby-identifier">param1</span> = <span class="ruby-identifier">method</span>.<span class="ruby-identifier">params</span>[<span class="ruby-value">0</span>]
<span class="ruby-identifier">puts</span> <span class="ruby-node">"#{param1.name} #{param1.optional?}"</span> <span class="ruby-comment"># => Filename true</span>
</pre>
<div class="method-source-code" id="optional-3F-source">
<pre>static VALUE
foleparam_optional(VALUE self)
{
struct oleparamdata *pparam;
TypedData_Get_Struct(self, struct oleparamdata, &oleparam_datatype, pparam);
return ole_param_flag_mask(pparam->pTypeInfo, pparam->method_index,
pparam->index, PARAMFLAG_FOPT);
}</pre>
</div>
</div>
</div>
<div id="method-i-output-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE#output?
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if argument is output.</p>
<pre>tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'DWebBrowserEvents')
method = WIN32OLE_METHOD.new(tobj, 'NewWindow')
method.params.each do |param|
puts "#{param.name} #{param.output?}"
end
The result of above script is following:
URL false
Flags false
TargetFrameName false
PostData false
Headers false
Processed true</pre>
<div class="method-source-code" id="output-3F-source">
<pre>static VALUE
foleparam_output(VALUE self)
{
struct oleparamdata *pparam;
TypedData_Get_Struct(self, struct oleparamdata, &oleparam_datatype, pparam);
return ole_param_flag_mask(pparam->pTypeInfo, pparam->method_index,
pparam->index, PARAMFLAG_FOUT);
}</pre>
</div>
</div>
</div>
<div id="method-i-retval-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_PARAM#retval?
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if argument is return value.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'DirectX 7 for Visual Basic Type Library'</span>,
<span class="ruby-string">'DirectPlayLobbyConnection'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'GetPlayerShortName'</span>)
<span class="ruby-identifier">param</span> = <span class="ruby-identifier">method</span>.<span class="ruby-identifier">params</span>[<span class="ruby-value">0</span>]
<span class="ruby-identifier">puts</span> <span class="ruby-node">"#{param.name} #{param.retval?}"</span> <span class="ruby-comment"># => name true</span>
</pre>
<div class="method-source-code" id="retval-3F-source">
<pre>static VALUE
foleparam_retval(VALUE self)
{
struct oleparamdata *pparam;
TypedData_Get_Struct(self, struct oleparamdata, &oleparam_datatype, pparam);
return ole_param_flag_mask(pparam->pTypeInfo, pparam->method_index,
pparam->index, PARAMFLAG_FRETVAL);
}</pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="WIN32OLE_PARAM.html#method-i-name">name</a>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>