KsUnserializeObjectPropertiesFromRegistry function (ks.h)

The KsUnserializeObjectPropertiesFromRegistry function, when given a destination object and a registry path, enumerates the named values and applies them as serialized data to the specified property sets listed in the serialized data. An IRP is generated when sending the serialized data, so no assumption is made on use of KS property structures to internally define the property sets. The function does not use the names of the values.

Syntax

KSDDKAPI NTSTATUS KsUnserializeObjectPropertiesFromRegistry(
  [in]           PFILE_OBJECT    FileObject,
  [in, optional] HANDLE          ParentKey,
  [in, optional] PUNICODE_STRING RegistryPath
);

Parameters

[in] FileObject

Specifies the file object whose properties are being set.

[in, optional] ParentKey

Optionally contains a handle to the parent of the path, or NULL. The Parent Key and/or the RegistryPath must be passed.

[in, optional] RegistryPath

Optionally contains the path to the key whose subkeys will be enumerated as property sets, or otherwise NULL. The ParentKey and/or the Registry Path must be passed.

Return value

The KsUnserializeObjectPropertiesFromRegistry function returns STATUS_SUCCESS if the property sets were unserialized. The function returns an error if the registry path was invalid, one of the subkeys was invalid, setting a property was unsuccessful, the serialized format was invalid, or a property set was not supported on the object.

Requirements

Requirement	Value
Target Platform	Universal
Header	ks.h (include Ks.h)
Library	Ks.lib