3.1.4.4 AddKey (Opnum 3)

  • Article

The AddKey method creates a node and adds it to the metabase as a subnode of an existing node at the specified path.

 HRESULT AddKey(
   [in] METADATA_HANDLE hMDHandle,
   [unique, in, string] LPCWSTR pszMDPath
 );

hMDHandle: An unsigned 32-bit integer value containing an open metabase handle specifying the node in the metabase where the new key is to be added.

pszMDPath: A pointer to a Unicode string that contains the new node's path, relative to the path of the hMDHandle parameter.

Return Values: A signed 32-bit value that indicates return status. If the method returns a negative value, it failed. If the 12-bit facility code (bits 16–27) is set to 0x007, the value contains a Win32 error code in the lower 16 bits. Zero or positive values indicate success, with the lower 16 bits in positive nonzero values containing warnings or flags defined in the method implementation. For more information about Win32 error codes and HRESULT values, see [MS-ERREF].

Return value/code

Description

0x00000000

S_OK

The call was successful.

0x80070005

E_ACCESSDENIED

General access denied error.

0x80070006

ERROR_INVALID_HANDLE

The handle is invalid.

0x80070057

E_INVALIDARG

One or more arguments are invalid.

0x800700B7

ERROR_ALREADY_EXISTS

Cannot create a file because that file already exists.

The opnum field value for this method is 3.

When processing this call, the server MUST do the following:

  • Check the handle parameter. This handle is valid if it is either the master root handle or a handle returned from a previous OpenKey call. If the handle is invalid, return ERROR_INVALID_HANDLE error.

  • The server SHOULD check whether the parent handle, hMDHandle, was opened for write access. If not, return E_ACCESSDENIED<4>.

  • Check whether the relative path has the right syntax and length. If not, return an error.

  • Check whether the relative path refers to an existing node. If so, return ERROR_ALREADY_EXISTS.

  • Add a new node to the tree that has the resultant path as a combined path of the parent node specified by the hMDHandle parameter and the relative path specified by the pszMDPath parameter. If any intermediate nodes are required, the server creates these nodes.