OV_Action::CreateAsURL()
OV_Action::CreateAsURL_Trans()

OV_Action CreateAsURL(: [in] string Url,; [in] string Caption,; [in, optional] string ParentName,; [in, optional] string Name,; [in, optional] string Description)
OV_Action CreateAsURL_Trans(: [in] string TransId,; [in] string Url,; [in] string Caption,; [in, optional] string ParentName,; [in, optional] string Name,; [in, optional] string Description)

Parameters

TransId: Transaction ID returned from OV_Transaction::Start().
Url: Contains an URL.
Caption: Caption (Display Name). If a tool with the same Caption/Display is already a child of the parent tool group, nothing happens, and the method fails with MDLAPI_E_TOOL_HIERPATH_EXISTS. If the Caption parameter is an empty string, contains invalid characters, or has more than 1024 characters, the method fails with MDLAPI_E_INVALID_CAPTION.
ParentName: The Name property of the instance of OV_Tools to which the newly created tool is added. Optional parameter. If you do not specify the parameter, or if it is equal to an empty string, the root tool group is used. If the specified tool group does not exist, the method fails with MDLAPI_E_PARENT_TOOLGROUP_NOT_EXIST.
Name: The Name property of an instance of OV_Action to be created. Optional parameter. If you do not specify the parameter, or if it is equal to an empty string, it is created as a new GUID. If a tool with the same Name already exists, nothing happens, and the method fails with MDLAPI_E_TOOL_NAME_EXISTS.
Description: Copied to the Description property. Optional parameter.

Calling Convention

These methods can be called from a WMI class or instance object.

Description

Creates a tool (new instance of OV_Action) as an URL, and adds it to an existing tool group (instance of OV_Tools).

All parameters are validated before the tool is actually generated. If any parameter does not match, the method fails with MDLAPI_E_INVALID_PARAMETER.

Return Value

Instance of the newly created OV_Action.

Extended Status Codes

MDLAPI_E_INVALID_PARAMETER: Parameter is not valid.
MDLAPI_E_INVALID_CAPTION: Specified object Caption parameter is not valid.
MDLAPI_E_TOOL_NAME_EXISTS: Tool with the same Name already exists.
MDLAPI_E_TOOL_HIERPATH_EXISTS: Tool with the same Caption is already a child of the parent tool group.
MDLAPI_E_PARENT_TOOLGROUP_NOT_EXIST: Parent Tool Group does not exist.
MDLAPI_E_TRANSACTION_NOT_EXIST: Transaction with the specified ID does not exist.

OV_Action::CreateAsURL() OV_Action::CreateAsURL_Trans()

OV_Action::CreateAsURL()
OV_Action::CreateAsURL_Trans()