Description
Sets the name of the PBDOM_OBJECT.
Syntax
pbdom_object_name.SetName(stringstrName)
Argument |
Description |
---|---|
pbdom_object_name |
The name of the PBDOM_OBJECT |
strName |
The new name you want to set for PBDOM_OBJECT |
Return value
Boolean.
Returns true if the name of the PBDOM_OBJECT was changed, and false otherwise.
Throws
EXCEPTION_PBDOM_OBJECT_INVALID_FOR_USE -- This PBDOM_OBJECT object is not associated with a derived PBDOM_OBJECT class object.
EXCEPTION_INVALID_ARGUMENT -- Input name string is invalid. This can happen if the string has been specifically set to null.
EXCEPTION_MEMORY_ALLOCATION_FAILURE -- Insufficient memory was encountered while executing this method.
EXCEPTION_INVALID_NAME -- The input name string does not conform to the W3C standards for XML names.
Usage
This name refers to the name of the particular derived PBDOM_OBJECT to which this PBDOM_OBJECT refers. Certain types of PBDOM_OBJECT do not have any name associated with them. See the description of GetName.
For example, PBDOM_DOCUMENT does not have any name, so calling the SetName method returns false.
See also