| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
SPL::slcPluginArgs Class Reference

The plugin argument class. More...

`#include <spl_pluginargs.h>`

Inheritance diagram for SPL::slcPluginArgs:

List of all members.

## Public Member Functions

SPL_API | slcPluginArgs (void)
| Default constructor.
SPL_API | slcPluginArgs (const slcPluginArgs &a_pluginArgs)
| Copy constructor.
virtual SPL_API | ~slcPluginArgs (void)
| Default destructor.
long SPL_API | SetArg (long a_lIndex, void *a_pvArg)
| Sets an argument at the specified index (0-based).
long SPL_API | SetArg (void *a_pvArg)
| Sets an argument at the next free position.
long SPL_API | GetCount (void)
| Returns the number of arguments.
long SPL_API | GetArg (long a_lIndex, void *a_pvArg)
| Gets the argument at the specified index.
long SPL_API | Clear (void)
| Returns the number of deleted arguments.

## Detailed Description

The plugin argument class.

## Constructor & Destructor Documentation

slcPluginArgs::slcPluginArgs | ( | void |  | ) |

Default constructor.

slcPluginArgs::slcPluginArgs | ( | const slcPluginArgs & | a_pluginArgs | ) |

Copy constructor.

slcPluginArgs::~slcPluginArgs | ( | void |  | ) | `[virtual]`

Default destructor.

## Member Function Documentation

long slcPluginArgs::Clear | ( | void |  | ) |

Returns the number of deleted arguments.

Returns:
  Number of arguments.

long slcPluginArgs::GetArg | ( | long | a_lIndex,
|  | void * | a_pvArg
| ) |  |

Gets the argument at the specified index.

Parameters:

  a_lIndex | [in] Index of argument to get.
  a_pvArg | [out] Pointer to a valid, allocated memory block holding the argument.

Returns:
  The argument's index (should not differ from a_lIndex!).

long slcPluginArgs::GetCount | ( | void |  | ) |

Returns the number of arguments.

Returns:
  Number of arguments.

long slcPluginArgs::SetArg | ( | long | a_lIndex,
|  | void * | a_pvArg
| ) |  |

Sets an argument at the specified index (0-based).

Parameters:

  a_lIndex | [in] Index where to fill the argument in.
  a_pvArg | [in] Pointer to an argument.

Returns:
  The argument's index (should not differ from a_lIndex!).

long slcPluginArgs::SetArg | ( | void * | a_pvArg | ) |

Sets an argument at the next free position.

Parameters:

  a_pvArg | [in] Pointer to an argument.

Returns:
  The argument's index.

The documentation for this class was generated from the following files:

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/libspl/include/spl_pluginargs.h
- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/libspl/source/spl_pluginargs.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines