ApiNetworkControl (Opnum 89)

3.1.4.89 ApiNetworkControl (Opnum 89)

The ApiNetworkControl method instructs the server to initiate, on the specified network, an operation that is defined by the specified control code. The operation is executed on the node where the specified network context handle was obtained.

error_status_t ApiNetworkControl(
  [in] HNETWORK_RPC hNetwork,
  [in] DWORD dwControlCode,
  [in, unique, size_is(nInBufferSize)] 
    UCHAR* lpInBuffer,
  [in] DWORD nInBufferSize,
  [out, size_is(nOutBufferSize), length_is(*lpBytesReturned)] 
    UCHAR* lpOutBuffer,
  [in] DWORD nOutBufferSize,
  [out] DWORD* lpBytesReturned,
  [out] DWORD* lpcbRequired,
  [out] error_status_t* rpc_status
);

hNetwork: An HNETWORK_RPC context handle that is obtained in a previous ApiOpenNetwork method call.

dwControlCode: Indicates the operation to perform on the network. MUST be one of the following values.

Value	Meaning
CLUSCTL_NETWORK_UNKNOWN 0x5000000	Verifies that control codes for the network are being processed.
CLUSCTL_NETWORK_GET_CHARACTERISTICS 0x5000005	Retrieves the intrinsic characteristics associated with the network.
CLUSCTL_NETWORK_GET_FLAGS 0x5000009	Retrieves the flags that are set for the network.
CLUSCTL_NETWORK_GET_NAME 0x5000029	Retrieves the name of the network.
CLUSCTL_NETWORK_GET_ID 0x5000039	Retrieves the unique ID for the network.
CLUSCTL_NETWORK_ENUM_COMMON_PROPERTIES 0x5000051	Retrieves a list of the common property names for the designated network.
CLUSCTL_NETWORK_GET_RO_COMMON_PROPERTIES 0x5000055	Retrieves the read-only common property values for the designated network.
CLUSCTL_NETWORK_GET_COMMON_PROPERTIES 0x5000059	Retrieves all common property values for the designated network.
CLUSCTL_NETWORK_SET_COMMON_PROPERTIES 0x540005E	Sets the common property values for the designated network.
CLUSCTL_NETWORK_VALIDATE_COMMON_PROPERTIES 0x5000061	Validates that the values supplied for the common properties are acceptable for the designated network.
CLUSCTL_NETWORK_GET_COMMON_PROPERTY_FMTS 0x5000065	Retrieves a list of the common property names and their corresponding data formats for the designated network.
CLUSCTL_NETWORK_ENUM_PRIVATE_PROPERTIES 0x5000079	Retrieves a list of the private property names for the designated network.
CLUSCTL_NETWORK_GET_RO_PRIVATE_PROPERTIES 0x500007D	Retrieves the read-only private property names for the designated network.
CLUSCTL_NETWORK_GET_PRIVATE_PROPERTIES 0x5000081	Retrieves all private property values for the designated network.
CLUSCTL_NETWORK_SET_PRIVATE_PROPERTIES 0x5400086	Sets the private property values for the designated network.
CLUSCTL_NETWORK_VALIDATE_PRIVATE_PROPERTIES 0x5000089	Validates that the supplied property list is valid.
CLUSCTL_NETWORK_GET_PRIVATE_PROPERTY_FMTS 0x0500008D	Retrieves a list of the private property formats for the designated network.

lpInBuffer: The input data for the operation that is specified by dwControlCode. See the following sections for the data structures that are required for each dwControlCode.

nInBufferSize: The size, in bytes, of the buffer that is specified by lpInBuffer.

lpOutBuffer: The output data for the operation that is specified by dwControlCode. The output buffer MUST be allocated and provided by the client.

nOutBufferSize: The available size of the buffer that is specified by lpOutBuffer, as allocated by the client.

lpBytesReturned: On successful completion of the method, the server MUST set lpBytesReturned to the number of bytes that are written to the lpOutBuffer buffer.

lpcbRequired: If nOutBufferSize indicates that the buffer that is specified by lpOutBuffer is too small for the output data, the server MUST return 0x000000EA (ERROR_MORE_DATA) and set lpcbRequired to the number of bytes that are required for the output buffer.

rpc_status: (Protocol version 3.0 only) A 32-bit integer that the RPC runtime MUST write indicating whether or not it succeeded in executing this method on the server. A value of 0x00000000 indicates that the method call was successfully transported to the server, executed with no faults with control returned to the client without encountering any communication faults. This value is separate from the value returned by the method and does not represent the success of the method. The client MUST treat all non-zero values the same, except as specified in section 3.2.4.6.

Return Values: The method MUST return the following error codes for the specified conditions.

Return value/code	Description
0x00000000 ERROR_SUCCESS	Success.
0x00000001 ERROR_INVALID_FUNCTION	The network that is designated by hNetwork does not support the operation that is designated by dwControlCode.
0x000000EA ERROR_MORE_DATA	The nOutBufferSize parameter indicates that the buffer that is pointed to by lpOutBuffer is not large enough to hold the data that resulted from the operation.

For any other conditions, this method MUST return some other value, and the client MUST treat all other values the same, except that the client SHOULD treat errors as specified in 3.2.4.6 as recoverable errors, and initiate the reconnect procedure, as specified in section 3.2.4.6.

Manage Your Profile | Legal | Contact Us | MSDN Flash Newsletter

Product Families

Resources

About Microsoft

Popular Places

Popular Searches

Popular Downloads