Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLStringProxy Class Reference

Class that allows modification of a string parameter in a template. More...

#include <SL_String.h>

List of all members.

Public Methods


Detailed Description

Class that allows modification of a string parameter in a template.


Constructor & Destructor Documentation

CSLStringProxy::CSLStringProxy CdotXSITemplate   in_pTemplate,
SI_Int    in_nIndex
 

Constructor. Connects to a parameter in the parent template

Parameters:
in_pTemplate  Pointer to the parent template
in_Index  Index of the parameter in the template

CSLStringProxy::CSLStringProxy  
 

Constructor Creates an unconnected proxy


Member Function Documentation

SI_Error CSLStringProxy::Connect CdotXSITemplate   in_pTemplate,
SI_Int    in_nIndex
 

Connects the proxy to a parameter of a template

Parameters:
in_pTemplate  Parent template
in_nIndex  Index of the parameter in the parent template
Return values:
SI_SUCCESS 

CSLStringProxy & CSLStringProxy::operator= const char *    in_pszValue
 

Assignment operator. Assigns in_Value to the parameter referred by this proxy.

Parameters:
in_Value  The new value
Returns:
Reference to the current object.

CSLStringProxy & CSLStringProxy::operator= const CSLStringProxy &    in_Value
 

Assignment operator. Assigns in_Value to the parameter referred by this proxy.

Parameters:
in_Value  The new value
Returns:
Reference to the current object.

SI_Bool CSLStringProxy::operator== const char *    in_pszToCompare
 

Comparison operator. Compares in_ToCompare with the value of the parameter referred by this proxy.

Parameters:
in_ToCompare  The instance to compare values with
Returns:
Whether or not the referred parameter and in_ToCompare are equal
Note:
String comparison is case-sensitive

SI_Bool CSLStringProxy::operator== const CSLStringProxy &    in_ToCompare
 

Comparison operator. Compares in_ToCompare with the value of the parameter referred by this proxy.

Parameters:
in_ToCompare  The instance to compare values with
Returns:
Whether or not the referred parameter and in_ToCompare are equal
Note:
String comparison is case-sensitive


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.