MemberRename
PowerScript function
Description
Renames a member in an OLE storage. The member can be another OLE
object (a substorage) or a stream.
Applies to
OLEStorage objects
Syntax
|
1 |
olestorage.MemberRename ( membername, newname ) |
|
Argument |
Description |
|---|---|
|
olestorage |
The name of an object variable of type OLEStorage |
|
membername |
A string whose value is the name of the member you want to |
|
newname |
A string whose value is the new name to be assigned to the |
Return value
Integer.
Returns 0 if it succeeds and one of the following negative values if
an error occurs:
-1 — The storage is not open
-2 — Member not found
-3 — Insufficient resources or too many files open
-4 — Access denied
-5 — Invalid storage state
-6 — Duplicate name
-9 — Other error
If any argument’s value is null, MemberRename returns null.
Examples
This example creates a storage object and opens an OLE object in a
file. It checks whether wordobj is a substorage within that object, and if
so renames it to memo and saves the object back to the file:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
boolean lb_memexists integer result stg_stuff = CREATE OLEStorage stg_stuff.Open("c:ole2mystuff.ole") stg_stuff.MemberExists("wordobj", lb_memexists) IF lb_memexists THEN result = & stg_stuff.MemberRename("wordobj", "memo") IF result = 0 THEN stg_stuff.Save() END IF |
See also