Get method

This method is implemented by the following interfaces. Click one of the links below to jump to the description of the method as it pertains to that interface.

File
CustomProperty

 

 

Get method

Copies the file to location on the server specified by the Path parameter.

Syntax

C++
HRESULT Get(
   BSTR Path
   BSTR* pRetVal)
Scripting languages
String = Object.Get(
   Path as String)

Parameters

Path

Specifies a location in which to store the file. You can specify just a directory or a full path.

pRetVal

Upon return, the full path of the stored file.

Return value

C++

The return code.
Scripting languages

String. The full path of the stored file.

Remarks

The Path parameter specifies either a directory or a full path including the file name.

  • If you specify only a directory, and a file with the same name as the File object already exists in that directory, then the stored file is given a unique name so that the existing file is not written over.

  • If you specify a full path, that file name included in that path is used, and any file with the same name is written over.

Home

Applies to
IERUFile

See also
Tracking Versions

 

Go to Top
 

Get method

Returns the value of the custom property with the given name.

Syntax

C++
HRESULT Get(
   BSTR Name,
   VARIANT* pRetVal)
Scripting languages
VariantVal = Object.Get(
   Name as String)

Parameters

Name

Specifies the name of the CustomProperty to get.

pRetVal

Upon return, the value of the CustomProperty.

Return value

C++

The return code.
Scripting languages

Variant. The value that corresponds to the Name specified.

Remarks

  1. For items and members, the following VARIANT types are currently supported: Bool, Short, Long, Date, String.  In addition, for items, the VARIANT type IDispatch == IERUMemberSet will be supported.

  2. If CustomProperty::Get cannot find a property with the given name, an EROOM_E_NOTFOUND exception is thrown.        

  3. If CustomProperty::Set tries to set a property value with an unsupported type (includes VT_EMPTY), an E_INVALIDARG exception is thrown. Any attempt to set or get a property with an external name whose length exceeds this value will result in an E_INVALIDARG exception.

  4. There is currently no method for deleting a custom property.

 

Go to Top

Home

Applies to
IERUCustomProperty