IMofCompiler::CompileBuffer method (wbemcli.h)

Article
10/13/2021

The IMofCompiler::CompileBuffer method compiles either a buffer containing binary MOF data or a text buffer in ASCII format. Binary MOF files contain parsed data and must be stored in the database. The CompileBuffer method only accepts multi-byte character arrays (string buffers) that are not NULL-terminated.

Syntax

HRESULT CompileBuffer(
  [in]      long                     BuffSize,
  [in]      BYTE                     *pBuffer,
  [in]      LPWSTR                   ServerAndNamespace,
  [in]      LPWSTR                   User,
  [in]      LPWSTR                   Authority,
  [in]      LPWSTR                   Password,
  [in]      LONG                     lOptionFlags,
  [in]      LONG                     lClassFlags,
  [in]      LONG                     lInstanceFlags,
  [in, out] WBEM_COMPILE_STATUS_INFO *pInfo
);

Parameters

[in] BuffSize

Size of the data pointed to by the pBuffer parameter.

[in] pBuffer

Pointer to the binary MOF file data or a text buffer in ASCII format.

[in] ServerAndNamespace

Name of the server and namespace.

This parameter is ignored unless the pBuffer parameter points to a text buffer. If the text MOF is passed without a #pragma statement, then the MOF file is compiled into the default namespace. If pBuffer points to a binary MOF file, then the ServerAndNamespace parameter must be NULL.

[in] User

Name of the user requesting the service.

This parameter specifies the credentials for compiling on remote computers. If the value is NULL, then the user context is whatever the current process is using. This is always ignored when connecting to the local computer. For more information, see the Remarks section.

[in] Authority

Specifies the credentials for compiling on remote computers. If the value is NULL, the authority context is whatever the current process is using. This parameter is always ignored when connecting to the local computer. For more information, see the Remarks section.

[in] Password

Specifies the credentials for compiling on remote computers. If the value is NULL, the password of the current context is used. This parameter is always ignored when connecting to the local computer.

[in] lOptionFlags

You can combine one or more of the following flags.

WBEM_FLAG_CHECK_ONLY

Performs only a syntax check.

WBEM_FLAG_AUTORECOVER

If the method is successful, it adds the file name to the list of files to be compiled during automatic database recovery.

This flag cannot be combined with the namespace, class, or instance flags.

WBEM_FLAG_CONSOLE_PRINT

Sends various useful messages to the console.

WBEM_FLAG_DONT_ADD_TO_LIST

Prevents the addition of the file to the list of files to be compiled during automatic database recovery.

This flag is not compatible with WBEM_FLAG_AUTORECOVER.

[in] lClassFlags

This parameter is ignored because the binary MOF file already contains the information. The parameter value should be 0.

[in] lInstanceFlags

Ignored because the binary MOF file already contains the information. The parameter value should be 0.

[in, out] pInfo

Pointer to a WBEM_COMPILE_STATUS_INFO that describes an error.

If the parameter value is not NULL, an error has occurred, and the structure is filled with error information.

Return value

This method returns WBEM_S_NO_ERROR if successful. If the method is unsuccessful, it returns WBEM_S_FALSE.

Remarks

If the User parameter takes the form <domain\user>, the Authority parameter must be NULL.

Binary MOF data can be generated by the CreateBMOF method, which stores the binary MOF data into a file that can be read before calling the CompileBuffer method.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	wbemcli.h (include Wbemidl.h)
Library	Wbemuuid.lib
DLL	Mofd.dll