History of getRegPath

== Syntax ==

int getRegPath(char * path, int length)

== Arguments ==

:path

::A pointer to the string which will contain the path.

:length

::Maximum length of the path string.

== Return ==

Returns ERROR_SUCCESS if the operation was successful, otherwise it returns one of the following integer error codes:

||ERROR_SUCCESS||(==0) no error||

||ERROR_FILE_NOT_FOUND||key or value name not found||

||ERROR_MORE_DATA||buffer wasn't big enough (e.g., getRegString, getRegData)||

||ERROR_NO_MORE_ITEMS||index >= # of values or subkeys (enumRegValue, enumRegSubKey)||

||ERROR_INVALID_FUNCTION||bad top-level key, etc||

||ERROR_INVALID_DATA||wrong data type or size (or size > 2048)||

||ERROR_BADDB||registry database is corrupt||

||ERROR_BADKEY||registry key is invalid||

||ERROR_CANTOPEN||registry key could not be opened||

||ERROR_CANTREAD||registry key could not be read||

||ERROR_CANTWRITE||registry key could not be written||

||ERROR_REGISTRY_CORRUPT||registry is corrupt||

||ERROR_REGISTRY_IO_FAILED||input/output to registry failed||

||ERROR_KEY_DELETED||Illegal operation attempted on a Registry key which has been marked for deletion.||

||ERROR_KEY_HAS_CHILDREN||cannot delete a key with subkeys (Windows NT)||

== Description ==

Gets the current registry path.

The length should be at least of size (MAX_PATH)? + 1 in order to fit any possible registry path. The string path must be large enough to hold length number of characters.

== Example ==

<code>

// Display the current registry path

getRegPath(&str0, 256);

Info("Current registry path: %s", str0);

</code>

== See Also ==

setRegPath, getRegRoot

== Comments ==

:Everyone can add his comments about his experiences with this function here. Tips for using it are welcome, too.